A simple invisible recaptcha v3 implementation
Project description
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_PUBLIC_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
-
versioning is done in versioning in
aldryn_forms_recaptcha_plugin/__init__.py
-
for each version a tag is added to the gitlab repository in the form of
^(\d+\.)?(\d+\.)?(\*|\d+)$
, example: 0.0.10 -
There is a PyPI version which relies on the gitlab tags (the download_url relies on correct gitlab tags being set): https://pypi.org/project/aldryn-forms-recaptcha-plugin/
-
There is a DjangoCMS / Divio Marketplace add-on which also relies on the gitlab tags: https://marketplace.django-cms.org/en/addons/browse/aldryn-forms-recaptcha-plugin/
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:
- python3 setup.py sdist bdist_wheel
- twine upload --repository-url https://test.pypi.org/legacy/ dist/*
- twine upload dist/*
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for aldryn-forms-recaptcha-plugin-1.0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb5f866aa3f5dc7d75d9af40828e146b8e758130251770f907f3b4bfa1b6bc56 |
|
MD5 | 5d1ac57f490250f2873d8f2b7cfc796e |
|
BLAKE2b-256 | 4932980afbc587909576234b931896980db81fe2df17a894c5ae46d971f15ccd |