Django rest recaptcha field for easy integration of google recaptcha with django-rest-framework.
Project description
Django Rest reCAPTCHA
================
**Django Rest reCAPTCHA field to add google recaptcha in django-rest-framework**
Requirements
------------
Tested with:
* Python: 2.7, 3.5
* Django: 1.8, 1.9, 1.10, 1.11
Installation
------------
#. Install with ``pip install django-rest-recaptcha``.
#. Add ``'recaptcha'`` to your ``INSTALLED_APPS`` setting.
#. Register and obtain recaptcha keys here `https://www.google.com/recaptcha/admin`
#. Add the obtained keys to settings(For testing and development you can leave it blank to use
default test keys as mentioned here `https://developers.google.com/recaptcha/docs/faq`).
For example:
.. code-block:: python
GR_CAPTCHA_SECRET_KEY = 'GoogleRecaptchaPrivateKey001'
Usage
-----
#. Now you can import and use the recaptcha field in your serializer.
For example:
.. code-block:: python
from rest_framework import serializers
from recaptcha.fields import ReCaptchaField
class ExampleSerializer(serializers.Serializer):
recaptcha = ReCaptchaField(write_only=True)
...
Unit Testing
~~~~~~~~~~~~
Django Rest reCAPTCHA uses an environment variable ``RECAPTCHA_TESTING`` which
helps tests. This environment variable should be set to ``"True"`` in your
testing environment and any value will be considered to be validated.
Example:
.. code-block:: python
import os
os.environ['RECAPTCHA_TESTING'] = 'True'
data = {'recaptcha': 'dummy value'}
response = client.post('/my/api/endpoint/', data)
assert response.status_code == 200
The code above may vary according to your testing suite.
================
**Django Rest reCAPTCHA field to add google recaptcha in django-rest-framework**
Requirements
------------
Tested with:
* Python: 2.7, 3.5
* Django: 1.8, 1.9, 1.10, 1.11
Installation
------------
#. Install with ``pip install django-rest-recaptcha``.
#. Add ``'recaptcha'`` to your ``INSTALLED_APPS`` setting.
#. Register and obtain recaptcha keys here `https://www.google.com/recaptcha/admin`
#. Add the obtained keys to settings(For testing and development you can leave it blank to use
default test keys as mentioned here `https://developers.google.com/recaptcha/docs/faq`).
For example:
.. code-block:: python
GR_CAPTCHA_SECRET_KEY = 'GoogleRecaptchaPrivateKey001'
Usage
-----
#. Now you can import and use the recaptcha field in your serializer.
For example:
.. code-block:: python
from rest_framework import serializers
from recaptcha.fields import ReCaptchaField
class ExampleSerializer(serializers.Serializer):
recaptcha = ReCaptchaField(write_only=True)
...
Unit Testing
~~~~~~~~~~~~
Django Rest reCAPTCHA uses an environment variable ``RECAPTCHA_TESTING`` which
helps tests. This environment variable should be set to ``"True"`` in your
testing environment and any value will be considered to be validated.
Example:
.. code-block:: python
import os
os.environ['RECAPTCHA_TESTING'] = 'True'
data = {'recaptcha': 'dummy value'}
response = client.post('/my/api/endpoint/', data)
assert response.status_code == 200
The code above may vary according to your testing suite.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-rest-recaptcha-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f04928add4decdddaeffb1482a1d413e42cc8a7eb82c4af1ecded47538efde78 |
|
MD5 | 4fd4f658bd351015fd24e418222d3e91 |
|
BLAKE2b-256 | e8c44e82793792acfd4e7f332bffbb7d59840b7d2890dea6c877fae82fe4fc84 |
Close
Hashes for django_rest_recaptcha-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3025dad5b720f51009f065eb6a957573e6bbe8c1d863d00ab795f4ef81f7694a |
|
MD5 | 8e7ed164996805b2060ad9da0598bed7 |
|
BLAKE2b-256 | 392bd5636b960a1d11e400139a4a2d4158cc5c3f2a4b4ed9d082af65a9c7d322 |