-django-recaptcha-works provides a Django form field that integrates the
-reCaptcha service. It is released under the terms of the BSD License.
+django-recaptcha-works is a ...
This reCaptcha implementation has no extra requirements other than Django.
-The app is based on the code snippet #1644 as published by Chris Beaven
- - http://djangosnippets.org/snippets/1644/
-The original code has been further modified by George Notaras in order to
-implement the following:
-- transform the snippet to a Django application release
-- add SSL support for both the captcha presentation and the communication
- with the reCaptcha servers
-- migration to the Google-hosted reCaptcha API
-- extension of the available application settings
-- addition of a decorator that adds the remote IP to the submitted form
-Development Web Site and Issue Tracker:
- - http://www.codetrax.org/projects/django-recaptcha-works
+Project Development Web Site:
+ * https://www.codetrax.org/projects/django-recaptcha-works
Public Source Code Repository:
-In order to use this app you need a valid reCaptcha key pair, which can
-be obtained for free from:
+How this distribution package is organized
+The following list outlines the kind of information each of the files of this
+distribution package contains:
+ * AUTHORS : List of all authors and contributors.
+ * BUGS : Information about how to file bug reports or ask for new features.
+ * HELP : Instructions on how to use this software.
+ * INSTALL : Information on how to install this application.
+ * LICENSE : The terms of the license that governs your use of this software.
+ * NOTICE : Copyright, trademark, attribution and sponsorship information.
+ * SUPPORT : Information on how to get support for this software.
-Add it to the INSTALLED_APPS in settings.py:
+How to read the HELP document
+The HELP document is written in reStructuredText (rst). Although
+reStructuredText is an easy-to-read plain text markup format, it is
+recommended to convert it to HTML for a better reading experience.
+In order to convert this document to HTML you need `docutils`, which
+you can install in your system using `pip`::
-The recaptchaworks app accepts the following configuration options:
RECAPTCHA_PUBLIC_KEY: The public key as obtained from google.com/recaptcha
-RECAPTCHA_PRIVATE_KEY: The private key as obtained from google.com/recaptcha
+Once `docutils` is installed, you can use the `rst2html.py` utility to
-RECAPTCHA_USE_SSL: True/False -- Enables/disables secure communication with
+ rst2html.py HELP help.html
-RECAPTCHA_OPTIONS: A dictionary with the recaptcha customization options.
-Read the following page for more information:
- - http://code.google.com/apis/recaptcha/docs/customization.html
-RECAPTCHA_PUBLIC_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-RECAPTCHA_PRIVATE_KEY = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
-RECAPTCHA_USE_SSL = True
-recaptchaworks provides a form field which can be attached to your forms.
-Implementing a reCaptcha protected form is a two step process.
-Step 1: Create the reCaptcha protected form:
- from django import forms
- from recaptchaworks.fields import RecaptchaField
- class RecaptchaProtectedForm(forms.Form):
- # ... other form fields
- recaptcha = RecaptchaField(label='Human test', required=True)
-Step 2: Use the ``fix_recaptcha_remote_ip`` decorator around the view that
-processes the form data. This is required because the remote IP is a mandatory
-argument for the verification of the information the user has submitted in the
-reCaptcha field, but it cannot be added to the form field automatically due to
-limitations of the Django framework.
- from recaptchaworks.decorators import fix_recaptcha_remote_ip
- def view(request, *args, **kwargs):
- if request.method == 'POST':
- # ... process the form data here
+Then use any web browser to view the exported `help.html` file.
-Copyright (c) 2009-2010 Chris Beaven (SmileyChris), http://smileychris.com/
-Copyright (c) 2010 George Notaras <firstname.lastname@example.org>, http://www.g-loaded.eu/
-Licensed under the BSD License.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.