Add new-style Google reCAPTCHA V2 or Invisible reCAPTCHA widgets to your Django forms simply by adding a NoReCaptchaField field to said forms.
In late 2014, Google updated their ReCaptcha service, changing its API. The update significantly changes the appearance and function of ReCaptcha. This has been referred to as ReCaptcha 2 or "nocaptcha recaptcha". In early 2017, Google added the Invisible reCAPTCHA.
This module is intended to be a successor to django-recaptcha to support the new style Google Recaptcha. It borrows a lot of the logic from the django-recaptcha, but has been updated to support the Google change.
For the Google documentation for this service, visit the following:
https://developers.google.com/recaptcha/intro
The original django-recaptcha project is located at the following location:
https://github.com/praekelt/django-recaptcha
webpn/django-nocaptcha-recaptcha is an updated fork of ImaginaryLandscape/django-nocaptcha-recaptcha + Invisible
reCAPTCHA provided by kz26/django-nocaptcha-recaptcha
- Implements Google's new "NoCaptcha ReCaptcha Field"
- Implements Google's new "Invisible reCAPTCHA"
- Uses the fallback option for browsers without JavaScript
- Easy to add to a Form via a FormField
- Works similar to django-recaptcha
- Working demo projects
- Works with Python 2.7 and 3.4
pip install django-nocaptcha-recaptcha
Add nocaptcha_recaptcha to your INSTALLED_APPS setting
Add the following to settings.py
Required settings:
NORECAPTCHA_SITE_KEY (string) = the Google provided site_key
NORECAPTCHA_SECRET_KEY (string) = the Google provided secret_key
Optional Settings:
NORECAPTCHA_VERIFY_URL (string) = reCaptcha api endpoint for verification.
Best to leave this as the default setting.
Default is https://www.google.com/recaptcha/api/siteverify
NORECAPTCHA_WIDGET_TEMPLATE (string) = location for the widget template.
Default is nocaptcha_recaptcha/widget.html
Add the field to a form that you want to protect.
from nocaptcha_recaptcha.fields import NoReCaptchaField
class DemoForm(forms.Form):
.....
captcha = NoReCaptchaField() # reCAPTCHA V2
First, you'll need to assign a unique ID to your form and submit button in the form template.
from nocaptcha_recaptcha.fields import NoReCaptchaField
from nocaptcha_recaptcha.widgets import InvisibleReCaptchaWidget
class DemoForm(forms.Form):
.....
captcha = NoReCaptchaField(
gtag_attrs={
'callback': 'onSubmit', # name of JavaScript callback function
'bind': 'submit-button' # submit button's ID in the form template
},
widget=InvisibleReCaptchaWidget
)
If you're using the Invisible reCAPTCHA, you'll also need to set up a callback using JavaScript:
<script>
function onSubmit(token) {
document.getElementById("form").submit();
}
</script>
Add Google's JavaScript library to your base template or elsewhere, so it is available on the page containing the django form.
<script src="https://www.google.com/recaptcha/api.js" async defer></script>
(optional) You can customize the field.
-
You can add attributes to the g-recaptcha div tag through the following
captcha = NoReCaptchaField(gtag_attrs={'data-theme':'dark'}))
-
You can override the template for the widget like you would any other django template.
The demo project includes a fully working example of this module. To use it, run the following:
cd demo
export NORECAPTCHA_SITE_KEY="<your site key>"
export NORECAPTCHA_SECRET_KEY="<your secret key>"
./manage.py runserver
# in a browser, visit http://localhost:8000
python setup.py test