README.rst

Description

Django-registration provides user registration functionality for Django websites.

maintainers

Macropin, DiCato, and joshblum

contributors

list of contributors

If you have issues with the "django-registration-redux" package then please raise them here.

This is a fairly simple user-registration application for Django, designed to make allowing user signups as painless as possible. It requires a functional installation of Django 1.8 or newer, but has no other dependencies.

Django 2.0 Alpha Pre-Release

We have a pre-release available to begin testing against Django 2.0. You can install this version by running:

pip install django-registration-redux==2.0a3

If you find any issues with this alpha release, please submit an issue or a pull request (compared against the django-2.0 branch). Once Django 2.0 is officially released, we will take our version out of alpha and officially drop support for Django<1.11 on master.

Installation

Install, upgrade and uninstall django-registration-redux with these commands:

pip install django-registration-redux
pip install --upgrade django-registration-redux
pip uninstall django-registration-redux

To install it manually, run the following command inside this source directory:

python setup.py install

Or if you'd prefer you can simply place the included registration directory somewhere on your Python path, or symlink to it from somewhere on your Python path; this is useful if you're working from a Git checkout.

Note that this application requires Python 2.7/3.4 or later, and a functional installation of Django 1.8 or newer.

Getting started with development

To get started with development, first install the required packages:

make installdeps

For convenience a Makefile is included which wraps the Python invoke library. Once you work on a patch, you can test the functionality by running:

make test

Or equivalently:

invoke test

Command line arguments can be passed to the invoke script through the Makefile via the ARGS parameter. For example:

make build ARGS=--docs

Or equivalently:

invoke build --docs

Alternatives

djangopackages.com has a comprehensive comparison of Django packages used for user registration and authentication.

For example, django-allauth is an alternative to django-registration-redux that provides user registration in addition to social authentication and email address management.

License

Django-registration-redux is licensed under BSD License.