Welcome to django-antispam’s documentation!¶
Various anti-spam protection tools for django applications.
Documentation¶
Get started¶
The package can be installed using:
pip install django-antispam
Add the following settings:
INSTALLED_APPS += [
'antispam',
# 'antispam.akismet',
# 'antispam.honeypot',
# 'antispam.captcha',
]
# Akismet protection configuration (optional)
AKISMET_API_KEY = '<akismet api-key>'
AKISMET_SITE_URL = '<base site url>'
AKISMET_TEST_MODE = False
# reCAPTCHA default configuration (optional)
RECAPTCHA_SITEKEY = 'sitekey'
RECAPTCHA_SECRETKEY = 'secretkey'
RECAPTCHA_WIDGET = 'antispam.captcha.widgets.ReCAPTCHA'
RECAPTCHA_TIMEOUT = 5
RECAPTCHA_PASS_ON_ERROR = False
Usage¶
Honeypot field¶
Honeypot is a spam protection technique to detect and block automatic spam spiders on your website. Also known as spamtrap technique.
See also
You can read more about this technique at Wikipedia.
Form protection is very simple, just add a HoneypotField to your form:
from django import forms
from antispam.honeypot.forms import HoneypotField
class MyForm(forms.Form):
name = forms.CharField()
spam_honeypot_field = HoneypotField()
HoneypotField uses standard form validation behaviour.
If spam submit was detected - ValidationError with spam-protection code will be raised.
Akismet¶
Akismet is an advanced hosted anti-spam service aimed at thwarting the underbelly of the web. It efficiently processes and analyzes masses of data from millions of sites and communities in real time.
See also
You can read more at Akismet official website.
Use Akismet protection for your project:
from django import forms
from antispam import akismet
class MyForm(forms.Form):
name = forms.CharField()
email = forms.EmailField()
comment = forms.TextField()
def __init__(self, **kwargs):
self.request = kwargs.pop('request', None)
super().__init__(**kwargs)
def clean():
if self.request and akismet.check(
request=akismet.Request.from_django_request(self.request),
comment=akismet.Comment(
content=self.cleaned_data['comment'],
type='comment',
author=akismet.Author(
name=self.cleaned_data['name'],
email=self.cleaned_data['email']
)
)
):
raise ValidationError('Spam detected', code='spam-protection')
return super().clean()
CAPTCHA¶
CAPTCHA – Completely Automated Public Turing test to tell Computers and Humans Apart. We support CAPTCHA implementation called reCAPTCHA V2.
reCAPTCHA V2¶
reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive CAPTCHAs to keep automated software from engaging in abusive activities on your site.
See also
You can read more at google reCAPTCHA official website.
To use reCAPTCHA protection in your project form, obtain keys from Google <https://www.google.com/recaptcha/admin>, add them to SETTINGS:
RECAPTCHA_SITEKEY = 'sitekey'
RECAPTCHA_SECRETKEY = 'secretkey'
and add ReCAPTCHA field:
from django import forms
from antispam.captcha.forms import ReCAPTCHA
class MyForm(forms.Form):
name = forms.CharField()
captcha = ReCAPTCHA()
- django-antispam package provides 2 widgets of reCAPTCHA:
antispam.captcha.widgets.ReCAPTCHA- default reCAPTCHA v2 widgetantispam.captcha.widgets.InvisibleReCAPTCHA- invisible reCAPTCHA widget
To display reCAPTCHA on website page, you should add reCAPTCHA script into the template:
{% load recaptcha %}
{% block head %}
...
{% recaptcha_init %}
{% endblock %}