Metadata-Version: 2.0
Name: nobot
Version: 0.2
Summary: Django recaptcha form field/widget app.
Home-page: https://github.com/EnTeQuak/nobot
Author: Christopher Grebs
Author-email: cg@webshox.org
License: BSD
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Framework :: Django
Requires-Dist: Django (>=1.4,<1.8)
Requires-Dist: requests (>=1.1.0)
Requires-Dist: six (>=1.9.0)
Provides-Extra: tests
Requires-Dist: pytest (>=2.5.2); extra == 'tests'
Requires-Dist: pytest-cov (>=1.6); extra == 'tests'
Requires-Dist: pytest-flakes (>=0.2); extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.5); extra == 'tests'
Requires-Dist: pytest-django (>=2.6); extra == 'tests'
Requires-Dist: pep8 (==1.4.6); extra == 'tests'
Requires-Dist: httpretty (>=0.8.4,<0.9); extra == 'tests'
Requires-Dist: mock (>=1.0.1,<1.1); extra == 'tests'

Nobot
=====

**Django reCAPTCHA form field/widget integration app.**


.. image:: https://travis-ci.org/EnTeQuAk/nobot.svg?branch=master
    :target: https://travis-ci.org/EnTeQuAk/nobot

.. image:: https://badge.fury.io/py/nobot.png
    :target: http://badge.fury.io/py/nobot

.. image:: https://pypip.in/d/nobot/badge.png
        :target: https://pypi.python.org/pypi/nobot


Installation
------------

#. Install or add ``nobot`` to your Python path.

#. Add ``nobot`` to your ``INSTALLED_APPS`` setting.

#. Add a ``NOBOT_RECAPTCHA_PUBLIC_KEY`` setting to the project's ``settings.py`` file. This is your public API key as provided by reCAPTCHA, i.e.::

    NOBOT_RECAPTCHA_PUBLIC_KEY = '76wtgdfsjhsydt7r5FFGFhgsdfytd656sad75fgh'

   This can be seperately specified at runtime by passing a ``public_key`` parameter when constructing the ``ReCaptchaField``, see field usage below.

#. Add a ``NOBOT_RECAPTCHA_PRIVATE_KEY`` setting to the project's ``settings.py`` file. This is your private API key as provided by reCAPTCHA, i.e.::

    NOBOT_RECAPTCHA_PRIVATE_KEY = '98dfg6df7g56df6gdfgdfg65JHJH656565GFGFGs'

   This can be seperately specified at runtime by passing a ``private_key`` parameter when constructing the ``ReCaptchaField``, see field usage below.


Usage
-----

Field
~~~~~

The quickest way to add reCAPTHCA to a form is to use the included ``ReCaptchaField`` field type. A ``ReCaptcha`` widget will be rendered with the field validating itself without any further action required from you. For example::

    from django import forms
    from nobot.fields import ReCaptchaField

    class FormWithCaptcha(forms.Form):
        captcha = ReCaptchaField()

The reCAPTCHA widget supports several `Javascript options variables <https://code.google.com/apis/recaptcha/docs/customization.html>`_ customizing the behaviour of the widget, such as ``theme`` and ``lang``. You can forward these options to the widget by passing an ``attr`` parameter containing a dictionary of options to ``ReCaptchaField``, i.e.::

    captcha = ReCaptchaField(attrs={'theme' : 'clean'})

The captcha client takes the key/value pairs and writes out the RecaptchaOptions value in JavaScript.


Credits
-------

Originally developed under the name `django-recaptcha <https://github.com/praekelt/django-recaptcha/>`_ by Praekelt Foundation. Forked for better testability and extensibility.
Authors
=======

``nobot`` was previously developed under the name `django-recaptcha` and under the
Copyright of Praekelt Foundation. The following copyright notice holds true for
releases before the renaming: "Copyright (c) by Praekelt Foundation

Package Maintainer
------------------
* Christopher Grebs

Praekelt Foundation
-------------------
* Shaun Sephton
* Peter Pistorius
* Hedley Roos

bTaylor Design
--------------
* `Brandon Taylor <http://btaylordesign.com/>`_

Other
-----
* Brooks Travis
* `Denis Mishchishin <https://github.com/denz>`_
* `Joshua Peper <https://github.com/zout>`_
* `Rodrigo Primo <https://github.com/rodrigoprimo>`_
* `snnwolf <https://github.com/snnwolf>`_
* `Adriano Orioli <https://github.com/Aorioli>`_
* `cdvv7788 <https://github.com/cdvv7788>`_


