django-mail-auth's Introduction

Django Mail Auth

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!

Note

Don't forget to setup you Email backend!

django-mail-auth's People

Contributors

Stargazers

Watchers

django-mail-auth's Issues

on createmigrations, 'NoneType' object has no attribute '_meta'

Hi there,
nice package! I really like the concept.
I get the below when I run python manage.py makemigrations (Django 3.1).

  File "C:\Users\andytwoods\PycharmProjects\pubpubs\VE\lib\site-packages\django\contrib\admin\checks.py", line 351, in _check_field_spec_item
    not field.remote_field.through._meta.auto_created):
AttributeError: 'NoneType' object has no attribute '_meta'

when I change line 57 of mailauth.contrib.user.models.py from

    class Meta(AbstractUser.Meta):
        abstract = True

class Meta(AbstractUser.Meta):
    pass

the error goes away.

Can you foresee any issue with that change? I'll make a pull request.

cheers,
Andy.

Failing migration with existing apps

Problem:
When running the migration the migration will fail with this error:

django.db.migrations.exceptions.InconsistentMigrationHistory: Migration app_name.0002_auto_XXXX is applied before its dependency mailauth_user.0001_initial on database 'default'.

Guess
its happening because an existing app is referencing in a migration the to=settings.AUTH_USER_MODEL and therefore the non existing user migration.

Expected behaviour
The migration should always run no matter what exists before.

My Workaround
I just delete AUTH_USER_MODEL = 'mailauth_user.EmailUser' for the duration of the migration

Recommend Projects

codingjoe / django-mail-auth Goto Github PK

django-mail-auth's Introduction

Django Mail Auth

Installation

Setup

django-mail-auth's People

Contributors

Stargazers

Watchers

Forkers

django-mail-auth's Issues

on createmigrations, 'NoneType' object has no attribute '_meta'

Failing migration with existing apps

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent