djangorestframework-registration

Overview

RESTful account registration, activation. This apps is inspired by django-registration. It uses the same templates as the django-registration.

This package is influenced by the django-registration HMAC workflow.

Registration Endpoint is an rest framework APIView, whereas Activation Endpoint is a django TemplateView.

Requirements

Python (3.4)
Django (1.8, 1.9)
Django REST Framework (3.3)

Installation

Install using pip…

$ pip install djangorestframework-registration

Example

Include the following urls.

urlpatterns = [
    url(r'^api-token-auth/', include('rest_framework_registration.urls')),
]

the available resources will be available at /api-token-auth/registrations/ and /api-token-auth/activations/<key>. See the source code for more detail.

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build