aldryn-forms-recaptcha-plugin

A simple invisible recaptcha v3 implementation


Install
pip install aldryn-forms-recaptcha-plugin==1.0.0.3

Documentation

Aldryn Forms Recaptcha Plugin

This python module is open-source, available here: https://gitlab.com/what-digital/aldryn-forms-recaptcha-plugin/

Setup

pip install aldryn-forms-recaptcha-plugin

Add the following to your settings.py:

INSTALLED_APPS = [
    'aldryn_forms_recaptcha_plugin',
    'snowpenguin.django.recaptcha3',  # must be below the plugin
]
RECAPTCHA_PUBLIC_KEY = env('RECAPTCHA_PRIVATE_KEY', '123')
RECAPTCHA_PRIVATE_KEY = env('RECAPTCHA_PRIVATE_KEY', '123')
# set this to 0 (or 1) to deactivate (or always activate) the captcha protection
RECAPTCHA_SCORE_THRESHOLD = 0.85

If you're using bootstrap4, beware that django renders the form errors with class invalid-feedback, which is invisible in bs4.

Versioning and Packages

In order to release a new version of the Divio add-on:

  • Increment version number in addons-dev/aldryn-forms-recaptcha-plugin/aldryn_forms_recaptcha_plugin/__init__.py
  • divio addon validate
  • divio addon upload
  • Then git add, commit and tag with the version number and push to the repo
git add .
git commit -m "<message>"
git tag 0.0.XX
git push origin 0.0.19

Then, in order to release a new pypi version:

Development

  • Run pip install -e ../aldryn-forms-recaptcha-plugin/ in your demo project
  • You can open aldryn_forms_recaptcha_plugin in pycharm and set the python interpreter of the demo project to get proper django support and code completion.

Dependencies

  • aldryn_forms