Skip to main content

Django authentication via login URLs, no passwords required.

Project description

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!

Project details


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.3.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

django_mail_auth-3.3.0-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_mail_auth-3.3.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for django_mail_auth-3.3.0.tar.gz
Algorithm Hash digest
SHA256 c2d87e14fc7a0da058ebb9b0b00820ad5361ea72797059b20d1de0d2f2eaa504
MD5 6fa95325d2d1c50c223ae228af15526d
BLAKE2b-256 d55261edfd24647183e4bf69a17a770aa0946d8bbc6af84cc95793bca0c27074

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_mail_auth-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 78bde84be83f1018040ba8139a3f9080582158a7fb3eb47b021a31dd1bf93664
MD5 49b8451c1068670ffb26fa7bad0f6aaa
BLAKE2b-256 919e3675c88e3da6816a73842d57eadd2833c79eff1debae3ee4daea1d0e8008

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page