An open API service indexing awesome lists of open source software.

https://github.com/christianwgd/django-friendly-captcha

Django field/widget for Friendly Capture (https://friendlycaptcha.com).
https://github.com/christianwgd/django-friendly-captcha

captcha django friendly-captcha

Last synced: about 1 year ago
JSON representation

Django field/widget for Friendly Capture (https://friendlycaptcha.com).

Awesome Lists containing this project

README

          

Django Friendly Captcha
=======================

.. image:: https://img.shields.io/pypi/v/django-friendly-captcha
:target: https://pypi.python.org/pypi/django-friendly-captcha

.. image:: https://img.shields.io/pypi/dm/django-friendly-captcha
:alt: PyPI - Downloads
:target: https://pypi.python.org/pypi/django-friendly-captcha

Django field/widget for Friendly Captcha (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.

.. code-block::

INSTALLED_APPS = [
...
'friendly_captcha',
]

Add the captcha field to your form:

.. code-block::

from friendly_captcha.fields import FrcCaptchaField

class ContactForm(forms.ModelForm):

class Meta:
model = ContactMessage
fields = (
'name', 'email', 'subject', 'text'
)

captcha = FrcCaptchaField()

As of version 0.1.7 the javascript static assets are included in
the widget, so there is no need to do that in your project templates.
Version 0.1.10 includes friendly captcha version 0.9.15 javascript files.
If you need a different version you can set these by providing
them in your settings:

.. code-block::

FRC_WIDGET_MODULE_JS = 'https://unpkg.com/friendly-challenge@0.9.8/widget.module.min.js'
FRC_WIDGET_JS = 'https://unpkg.com/friendly-challenge@0.9.8/widget.min.js'

For version 0.1.6 and below you need to include the script tags from
Friendly Captcha to your forms template
(see https://docs.friendlycaptcha.com/#/installation)

.. code-block::


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.

.. code-block::

FRC_CAPTCHA_SECRET = '