Skip to main content

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!

Metadata

Release files for django-mail-auth 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-mail-auth 0.2.0
File Size Uploaded
django-mail-auth-0.2.0.tar.gz 92.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-mail-auth 0.2.0
File Interpreter ABI Platform
django_mail_auth-0.2.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 115.9 kB

Release files / django-mail-auth-0.2.0.tar.gz

Download URL django-mail-auth-0.2.0.tar.gz
Size 92.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f838372854cf7f57f5267f75f427a50f4054f8540dcd685fc869d605a9215f18
BLAKE2b-256 checksum
How to use checksums
06a4f1c85ca36f6ab7bf9e66851aebc2d95e9e1e1572a08d601bfbbca60c1166
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

Release files / django_mail_auth-0.2.0-py2.py3-none-any.whl

Download URL django_mail_auth-0.2.0-py2.py3-none-any.whl
Size 23.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
80fe093d39992b4b18e5ae5ab20b5b0d07869ae7acae3e0514a38601a9a413c1
BLAKE2b-256 checksum
How to use checksums
3c3633d938ee9342396428be26b08740d2d1cecf57d84d1afe94bed19d142ec9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

Release history Release notifications | RSS feed

3.5.5

2 release files

3.5.4

2 release files

3.5.3

2 release files

3.5.2

2 release files

3.5.1

2 release files

3.5.0

2 release files

3.4.1

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.2

2 release files

3.2.1

2 release files

3.2.0

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.3.0

2 release files

This release

0.2.0 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page