Skip to main content

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.auth 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 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!

Release files for django-mail-auth 0.1.4

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.1.4
File Size Uploaded
django-mail-auth-0.1.4.tar.gz 92.3 kB Details

Built distribution (wheel)

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

Total release size: 114.6 kB

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

Download URL django-mail-auth-0.1.4.tar.gz
Size 92.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1cf9b6f24b302b9c028162f01acc0f876e57cfd4b4dd0eaa0f2949370687173e
BLAKE2b-256 checksum
How to use checksums
aa7db95ec75070ea27c119af090de87f57d9752a39db674ce663e768d798e3da
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.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

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

Download URL django_mail_auth-0.1.4-py2.py3-none-any.whl
Size 22.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2e55d28b81a5832e5437492ae54f8ceda0f9c2e62e54a8318e6f1cf9f7d68370
BLAKE2b-256 checksum
How to use checksums
ad513cd4a56f26a7d68b884f4a253215936cff60ca36f904b9f259a1dc0c5e40
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.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 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

0.2.0

2 release files

This release

0.1.4 This release

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