Installation¶
Requirements¶
Python >= 3.6
Django >= 2.2 and <= 3.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+https://github.com/cdriehuys/django-rest-email-auth.git#egg=django-rest-email-auth
Required Configuration¶
In settings.py
, make sure the following settings are present:
INSTALLED_APPS = [
# At least these default Django apps must be installed:
'django.contrib.auth',
'django.contrib.contenttypes',
# DRF must be listed for the browseable API to work
'rest_framework',
# Finally, the app itself
'rest_email_auth',
]
AUTHENTICATION_BACKENDS = [
'rest_email_auth.authentication.VerifiedEmailBackend',
'django.contrib.auth.backends.ModelBackend',
]
# The minimal settings dict required for the app
REST_EMAIL_AUTH = {
'EMAIL_VERIFICATION_URL': 'https://example.com/verify/{key}',
'PASSWORD_RESET_URL': 'https://example.com/reset/{key}',
}
See Configuration for a full list of settings.
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.
URLs¶
After the settings have been configured, include the app’s URLs in
urls.py
:
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')),
]
Post-Installation¶
After the app has been installed and configured, its migrations must be run:
$ manage.py migrate