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
drop in Wagtail login replacement
extendable SMS support
This project was inspired by:
Installation
Run this command to install django-mail-auth:
python3 -m pip install django-mail-auth[wagtail]
Setup
First add mailauth to you installed apps:
INSTALLED_APPS = [
# Django's builtin apps…
'mailauth',
'mailauth.contrib.admin', # optional
'mailauth.contrib.user', # optional
# optional, must be included before "wagtail.admin"
'mailauth.contrib.wagtail',
# 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:
# This setting should be either "EmailUser" or # any custom subclass of "AbstractEmailUser" AUTH_USER_MODEL = 'mailauth_user.EmailUser' # optional, Wagtail only WAGTAILUSERS_PASSWORD_ENABLED = False
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')),
# optional, must be before "wagtail.admin.urls"
path('', include('mailauth.contrib.wagtail.urls')),
]
That’s it!
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django-mail-auth-3.1.4.tar.gz.
File metadata
- Download URL: django-mail-auth-3.1.4.tar.gz
- Upload date:
- Size: 107.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fdb35190a3ea2d837161fdb388acf99074a3c653891bfb06e24640524ea5c820
|
|
| MD5 |
f86b3510100ac57c6972ae710802ea05
|
|
| BLAKE2b-256 |
63e478060d2835b02e0eb5870c1776d95ab4eaa01872c48cd74db65e2fd714cc
|
File details
Details for the file django_mail_auth-3.1.4-py2.py3-none-any.whl.
File metadata
- Download URL: django_mail_auth-3.1.4-py2.py3-none-any.whl
- Upload date:
- Size: 31.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c7a11520b467509589d0980e51885ce4cefc584ed5f4d329ed47c229120a80b4
|
|
| MD5 |
663342436346ebd1de36dabdd26dc792
|
|
| BLAKE2b-256 |
1a5327cff17e2c85b78b01fdc6a4e9d0cfd10a708fc36e256233b94ac40c9b87
|
