Skip to main content

Django authentication via login URLs, no passwords required

Project description

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!

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

Uploaded Source

Built Distribution

django_mail_auth-0.3.0-py2.py3-none-any.whl (23.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-mail-auth-0.3.0.tar.gz.

File metadata

  • Download URL: django-mail-auth-0.3.0.tar.gz
  • Upload date:
  • Size: 93.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.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

File hashes

Hashes for django-mail-auth-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1c77c896f2af35ee096b346cefceecc44417558f58c3cf08639acc25f1ded4ec
MD5 50fbf7439a5596ffc9f1d3751cc0b253
BLAKE2b-256 cd386e8477dfd0f78c72f2543cfc1ff5eac3d77b055880d7610635ea45db2de7

See more details on using hashes here.

File details

Details for the file django_mail_auth-0.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: django_mail_auth-0.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.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

File hashes

Hashes for django_mail_auth-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cb53a3563d216eebd66ce76a42385d5477c4195344d207425670a99a7b870ace
MD5 e3c8d446f6bb7ccd008219faf8af9d0f
BLAKE2b-256 027d089b89f936f698c4bff06ba5e2721373478a3ef956bf1cf5066b6b359209

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page