Skip to main content

version Documentation Status 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

  • 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 configuration 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

django_mail_auth-3.5.1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_mail_auth-3.5.1-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file django_mail_auth-3.5.1.tar.gz.

File metadata

  • Download URL: django_mail_auth-3.5.1.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_mail_auth-3.5.1.tar.gz
Algorithm Hash digest
SHA256 c31e0e9ca9d95b01bebfe375491b0a8442120d1cc35a9a2375a134e0c534bba6
MD5 c2ec9c6e0cb84cf2b63e532ff5cc28f6
BLAKE2b-256 fa6b16c63fc6de761159c0eaed66c0e29f59e1dd3419e27b01264c3a2dc1c92c

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mail_auth-3.5.1.tar.gz:

Publisher: release.yml on codingjoe/django-mail-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_mail_auth-3.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mail_auth-3.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c11552443ceee5a04deebddab28edeba289f2773b9bf94f9028204c7b9f18f27
MD5 d653b433eacd6f21b3bc9f56835aadf2
BLAKE2b-256 cce191206a4043bfebca8613d572ae0c8e50edd367bda888a1b70254f56cd478

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mail_auth-3.5.1-py3-none-any.whl:

Publisher: release.yml on codingjoe/django-mail-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

3.5.5

2 files

3.5.4

2 files

3.5.3

2 files

3.5.2

2 files

This release

3.5.1 This release

2 files

3.5.0

2 files

3.4.1

2 files

3.4.0

2 files

3.3.0

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.4

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 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