reCAPTCHA field for Django REST framework serializers.
Project description
===============================
Django REST framework reCAPTCHA
===============================
.. image:: https://badge.fury.io/py/djangorestframework-recaptcha.svg
:target: https://badge.fury.io/py/djangorestframework-recaptcha
.. image:: https://travis-ci.org/Maximilien-R/django-rest-framework-recaptcha.svg?branch=master
:target: https://travis-ci.org/Maximilien-R/django-rest-framework-recaptcha
.. image:: https://coveralls.io/repos/github/Maximilien-R/django-rest-framework-recaptcha/badge.svg?branch=master
:target: https://coveralls.io/github/Maximilien-R/django-rest-framework-recaptcha?branch=master
.. image:: https://readthedocs.org/projects/django-rest-framework-recaptcha/badge/?version=latest
:target: https://django-rest-framework-recaptcha.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Django REST framework reCAPTCHA provides you a serializer field to handle and
validate Google reCAPTCHA response.
Documentation
-------------
The full documentation is at https://django-rest-framework-recaptcha.readthedocs.io.
Requirements
------------
* Python: 2.7, 3.4, 3.5, 3.6, 3.7
* Django: 1.10, 1.11, 2.0, 2.1
* Django REST framework: 3.4, 3.5, 3.6, 3.7, 3.8, 3.9
Installation
------------
To install Django REST framework reCAPTCHA, run this command in your terminal:
.. code-block:: console
$ pip install djangorestframework-recaptcha
This is the preferred method to install Django REST framework reCAPTCHA, as it
will always install the most recent stable release.
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Once the ``djangorestframework-recaptcha`` installed, add it to your
``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS = (
...
"rest_framework_recaptcha",
...
)
Next, register yourself and obtain your reCAPTCHA credentials at
https://www.google.com/recaptcha/admin.
Finally, copy/paste your Google reCAPTCHA secret key to the
``DRF_RECAPTCHA_SECRET_KEY`` setting:
.. code-block:: python
DRF_RECAPTCHA_SECRET_KEY = "<your_reCAPTCHA_secret_key>"
Usage
-----
To use Django REST framework reCAPTCHA within your project you'll need to
import and add the ``ReCaptchaField`` serializer field into the wanted
serializer. For example:
.. code-block:: python
from rest_framework import serializers
from rest_framework_recaptcha import ReCaptchaField
class MySerializer(serializers.Serializer):
recaptcha = ReCaptchaField()
History
=======
[Unreleased]
------------
0.2.0 (2018-12-21)
------------------
Added
~~~~~
* Django REST framework 3.9, Python 3.7 & Django 2.1.
* Set long description content type to reStructuredText.
0.1.0 (2018-07-02)
------------------
Added
~~~~~
* First release on PyPI.
Django REST framework reCAPTCHA
===============================
.. image:: https://badge.fury.io/py/djangorestframework-recaptcha.svg
:target: https://badge.fury.io/py/djangorestframework-recaptcha
.. image:: https://travis-ci.org/Maximilien-R/django-rest-framework-recaptcha.svg?branch=master
:target: https://travis-ci.org/Maximilien-R/django-rest-framework-recaptcha
.. image:: https://coveralls.io/repos/github/Maximilien-R/django-rest-framework-recaptcha/badge.svg?branch=master
:target: https://coveralls.io/github/Maximilien-R/django-rest-framework-recaptcha?branch=master
.. image:: https://readthedocs.org/projects/django-rest-framework-recaptcha/badge/?version=latest
:target: https://django-rest-framework-recaptcha.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Django REST framework reCAPTCHA provides you a serializer field to handle and
validate Google reCAPTCHA response.
Documentation
-------------
The full documentation is at https://django-rest-framework-recaptcha.readthedocs.io.
Requirements
------------
* Python: 2.7, 3.4, 3.5, 3.6, 3.7
* Django: 1.10, 1.11, 2.0, 2.1
* Django REST framework: 3.4, 3.5, 3.6, 3.7, 3.8, 3.9
Installation
------------
To install Django REST framework reCAPTCHA, run this command in your terminal:
.. code-block:: console
$ pip install djangorestframework-recaptcha
This is the preferred method to install Django REST framework reCAPTCHA, as it
will always install the most recent stable release.
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Once the ``djangorestframework-recaptcha`` installed, add it to your
``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS = (
...
"rest_framework_recaptcha",
...
)
Next, register yourself and obtain your reCAPTCHA credentials at
https://www.google.com/recaptcha/admin.
Finally, copy/paste your Google reCAPTCHA secret key to the
``DRF_RECAPTCHA_SECRET_KEY`` setting:
.. code-block:: python
DRF_RECAPTCHA_SECRET_KEY = "<your_reCAPTCHA_secret_key>"
Usage
-----
To use Django REST framework reCAPTCHA within your project you'll need to
import and add the ``ReCaptchaField`` serializer field into the wanted
serializer. For example:
.. code-block:: python
from rest_framework import serializers
from rest_framework_recaptcha import ReCaptchaField
class MySerializer(serializers.Serializer):
recaptcha = ReCaptchaField()
History
=======
[Unreleased]
------------
0.2.0 (2018-12-21)
------------------
Added
~~~~~
* Django REST framework 3.9, Python 3.7 & Django 2.1.
* Set long description content type to reStructuredText.
0.1.0 (2018-07-02)
------------------
Added
~~~~~
* First release on PyPI.
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 djangorestframework-recaptcha-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0442bd9ca9a8f21737a57f1ea7e7bf1c872e725b2423fd34304a821bceec0ff |
|
MD5 | 1179914e7f7fcb7d06dd054e3522f64a |
|
BLAKE2b-256 | 47a4fdc91ffa1f66f984ed12dd4583f681d4353f022307ef8ca321b82a7a7c96 |
Close
Hashes for djangorestframework_recaptcha-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d5f0353bc6fa8f7d30b72000a08d1ef1f3ba1bf9162d596a70a02ee119b1d95 |
|
MD5 | 477b96e5f0b633e5354688e8de702652 |
|
BLAKE2b-256 | a401e3611baf28e3ca1babda3134dd1fbfd7cb0c7f559f01f4ed770b154ebc62 |