Django library for friendly captcha
Project description
Django library for Friendly Capture (https://friendlycaptcha.com).
Installation
Latest version:
pip install -e git+git://github.com/christianwgd/django-friendly-captcha.git#egg=django-friendly-captcha
Stable version:
pip install django-friendly-captcha
Documentation
Usage
Add ‘friendly_captcha’ to your INSTALLED_APPS.
INSTALLED_APPS = [
...
'friendly_captcha',
]
Add the captcha field to your form:
from friendly_captcha.fields import FrcCaptchaField
class ContactForm(forms.ModelForm):
class Meta:
model = ContactMessage
fields = (
'name', 'email', 'subject', 'text'
)
captcha = FrcCaptchaField()
Add the script tags from friendly capture to your forms template (see https://docs.friendlycaptcha.com/#/installation)
<script type="module" src="https://unpkg.com/friendly-challenge@0.8.1/widget.module.min.js" async defer></script>
<script nomodule src="https://unpkg.com/friendly-challenge@0.8.1/widget.min.js" async defer></script>
I thought about adding these static assets as form media assets, but users wouldn’t be able to choose the desired version. So I decided against for now.
If you build up your form from single fields, dont’t forget to include the captcha form field.
Configuration
Register to Friendly Captcha at https://friendlycaptcha.com/signup to get your sitekey and captcha secret.
FRC_CAPTCHA_SECRET = '<yourCaptchaSecret'
FRC_CAPTCHA_SITE_KEY = '<yourCaptchaSiteKey>'
FRC_CAPTCHA_VERIFICATION_URL = 'https://friendlycaptcha.com/api/v1/siteverify'
In default the form will fail with an error (‘Captcha test failed’). You can change this behaviour by setting FRC_CAPTCHA_FAIL_SILENT to True.
FRC_CAPTCHA_FAIL_SILENT = False
When setting FAIL_SILENT to True it’s up to you to handle captcha verification:
# in your form view
def form_valid(self, form):
captcha_verified = form.cleaned_data['captcha']
if captcha_verified:
# send mail or whatever ...
else:
# capture verification failed, do nothing ...
Logging
If you want to log the results of the captcha verifications you can add a logger to your logging configuration:
'django.friendly_captcha': {
'handlers': ['default'],
'level': 'INFO',
}
Releases
django_friendly_captcha 0.1.0 (March 2021): Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-friendly-captcha-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dffe9bf20e0ab16b0ba6334940f398c38947510384652d70ea09852c837f66cf |
|
MD5 | 06bfd2c60d6c31a3c58ef0d9bfec72f5 |
|
BLAKE2b-256 | 1c586493ebc97298734ea5981daf443ea373e9f5c1dc3bbe8759794397ec9a58 |
Hashes for django_friendly_captcha-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f255552275dc6ea53af039d5d9f5d3608e47c9d5f135d7f3f896d76286003eb5 |
|
MD5 | d3f01d883d885d0d0cdb3899d9865055 |
|
BLAKE2b-256 | 02c55009cedc28d89bb4144f33f93d70c39d3be8f7c3b0dc5ef11b8de7fb2cff |