• Python 3.6 or 3.7
  • Django 1.11, 2.0, or 2.1. Other versions may work, but they are not officially supported.

Getting the Package

The easiest way to install the package is with pip.

To get the most recent release:

$ pip install django-rest-email-auth

To get the most recent development build:

$ pip install git+

Required Configuration

In, make sure the following settings are present:

    # At least these default Django apps must be installed:

    # DRF must be listed for the browseable API to work

    # Finally, the app itself


# The minimal settings dict required for the app
    'PASSWORD_RESET_URL': '{key}',

Email Setup

In addition to the above settings, we also require that Django be configured to send emails. Please configure any of the EMAIL_* settings that apply to your setup. See Django’s email settings for more information.


After the settings have been configured, include the app’s URLs in

from django.urls import include, path
# If you're using Django 1.11:
# from django.conf.urls import include, url

urlpatterns = [
    path('account/', include('rest_email_auth.urls')),

    # If you're using Django 1.11:
    # url(r'account/', include('rest_email_auth.urls')),


After the app has been installed and configured, its migrations must be run:

$ migrate