Django Mail Auth

version Documentation Status ci coverage license

screenshot from a login form

Django Mail Auth is a lightweight authentication backend for Django, that does not require users to remember passwords.

Django Mail Auth features:

  • custom user model support
  • drop in Django admin support
  • drop in Django User replacement
  • extendable SMS support

This project was inspired by:

Installation

Run this command to install django-mail-auth:

pip install django-mail-auth

Setup

First add mailauth to you installed apps:

INSTALLED_APPS = [
    # Django's builtin apps…

    'mailauth',
    'mailauth.contrib.admin',  # optional
    'mailauth.contrib.user',  # optional

    # other apps…
]

mailauth.contrib.admin is optional and will replace the admin’s login with token based authentication too.

mailauth.contrib.user is optional and provides a new Django User model. The new User model needs to be enabled via the AUTH_USER_MODEL setting:

AUTH_USER_MODEL = 'mailauth_user.EmailUser'

Next you will need to add the new authentication backend:

AUTHENTICATION_BACKENDS = (
    # default, but now optional
    # This should be removed if you use mailauth.contrib.user or any other
    # custom user model that does not have a username/password
    'django.contrib.auth.backends.ModelBackend',

    # The new access token based authentication backend
    'mailauth.backends.MailAuthBackend',
)

Django’s ModelBackend is only needed, if you still want to support password based authentication. If you don’t, simply remove it from the list.

Last but not least, go to your URL root config urls.py and add the following:

from django.urls import path


urlpatterns = [
    path('accounts/', include('mailauth.urls')),
]

That’s it!

Note

Don’t forget to setup you Email backend!