Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Password-less authentication: login by clicking on a magic link received by email.

Project description

Django Magicauth

Authentifiez vos utilisateurs sans mot de passe avec Django Magicauth

Fonctionnement (FR)

Lorsqu'un service utilise Django Magicauth, les utilisateurs s'authentifient en entrant leur adresse email. Ils reçoivent alors un email avec un lien de connexion. S'ils cliquent sur le lien, ils sont authentifiés et redirigés sur le service.

How it works (EN)

Django Magicauth brings password-less authentication to your project.

Installations and testing instructions (EN)

Quick start

  1. Install MagicAuth
pip install git+https://github.com/betagouv/django-magicauth.git
  1. Add "magicauth" to your INSTALLED_APPS in settings.py
INSTALLED_APPS = [
    # all your apps
    "magicauth",
]
  1. Include the magicauth URLconf in your app's url.py
# After your previous imports
from magicauth import views as magicauth_views
from magicauth.urls import urlpatterns as magicauth_urls

urlpatterns = [
    # here are your URL patterns
]

urlpatterns.extend(magicauth_urls)
  1. Add the following items in your project's settings.py`
MAGICAUTH_FROM_EMAIL=e.g. 'contact@mysite.com'
MAGICAUTH_LOGGED_IN_REDIRECT_URL_NAME=e.g. 'home'
  1. Run python manage.py migrate to create the polls models.

  2. Setup your (mailer)[https://docs.djangoproject.com/en/2.2/topics/email/#console-backend] in settings.py In dev mode, you can use a (console mailer)[https://docs.djangoproject.com/en/2.2/topics/email/#console-backend]

  3. Make sure you have the following middlewares

MIDDLEWARE = [
    # [...] other middleware you may have
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.sites.middleware.CurrentSiteMiddleware",
]

Contribute to Magic auth

To contribute to magicauth, you can install the package in the "editable" mode

pip uninstall django-magicauth  # just in case...
pip install -e git+https://github.com/betagouv/django-magicauth.git#egg=django-magicauth

run tests

DJANGO_SETTINGS_MODULE=magicauth.tests.settings pytest

Project details


Release history Release notifications

This version

0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-magicauth, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size django-magicauth-0.2.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page