django-hcaptcha-field

Django hCaptcha Field

Django hCaptcha Field provides a simple way to protect your Django forms using hCaptcha.

This is a fork of django-hcaptcha.

Installation

1. Install using pip:

   $ pip install django-hcaptcha-field
   

2. Add to INSTALLED_APPS:

   INSTALLED_APPS = [
       # ...
       'hcaptcha_field'
   ]
   

Configuration

For development purposes no further configuration is required. By default, Django hCaptcha Field will use test keys.

For production, you'll need to obtain your hCaptcha site key and secret key and add them to you settings:

HCAPTCHA_SITEKEY = '<your sitekey>'
HCAPTCHA_SECRET = '<your secret key>'

You can also configure your hCaptcha widget globally (see all options):

HCAPTCHA_DEFAULT_CONFIG = {
    'onload': 'name_of_js_function',
    'render': 'explicit',
    'theme': 'dark',  # do not use data- prefix
    'size': 'compact',  # do not use data- prefix
    # ...
}

If you need to, you can also override default hCaptcha endpoints:

HCAPTCHA_JS_API_URL = 'https://hcaptcha.com/1/api.js'
HCAPTCHA_VERIFY_URL = 'https://hcaptcha.com/siteverify'

Use proxies:

HCAPTCHA_PROXIES = {
   'http': 'http://127.0.0.1:8000',
}

Change default verification timeout:

HCAPTCHA_TIMEOUT = 5

Usage

Simply add hCaptchaField to your forms:

from hcaptcha_field import hCaptchaField

class Form(forms.Form):
    hcaptcha = hCaptchaField()

You can override the sitekey and other default configuration by passing additional arguments:

from hcaptcha_field import hCaptchaField

class Form(forms.Form):
    hcaptcha = hCaptchaField(sitekey='...', theme='dark', size='compact')

License

The scripts and documentation in this project are released under the BSD-3-Clause License.