https://github.com/teapow/django-simple-authentication

Email identification authentication app for Django.
https://github.com/teapow/django-simple-authentication

auth authentication django

Last synced: 5 months ago
JSON representation

Email identification authentication app for Django.

• Host: GitHub
• URL: https://github.com/teapow/django-simple-authentication
• Owner: teapow
• License: other
• Created: 2018-08-27T09:06:24.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-11T20:03:39.000Z (almost 7 years ago)
• Last Synced: 2025-09-25T07:30:59.185Z (9 months ago)
• Topics: auth, authentication, django
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
============================

django-simple-authentication

============================

|travis| |codacy| |coverage| |pypi|

.. |travis| image:: https://travis-ci.org/teapow/django-simple-authentication.svg?branch=master

   :target: https://travis-ci.org/teapow/django-simple-authentication

.. |codacy| image:: https://api.codacy.com/project/badge/Grade/b3b408b162c14cc0b0d2ba6b46b86396

   :target: https://www.codacy.com/app/teapow/django-simple-authentication

.. |coverage| image:: https://api.codacy.com/project/badge/Coverage/b3b408b162c14cc0b0d2ba6b46b86396

   :target: https://www.codacy.com/app/teapow/django-simple-authentication

.. |pypi| image:: https://badge.fury.io/py/django-simple-authentication.svg

    :target: https://badge.fury.io/py/django-simple-authentication

Django's ``auth.User`` model uses a ``username`` field to uniquely identify a

user. ``django-simple-authentication`` uniquely identifies users with an

email address instead, removing the ``username`` field altogether.

Additionally, ``django-simple-authentication`` offers a feature that forces

users to change their password the next time they log in. This can be done

by setting ``simple_authentication.User.force_password_change`` to ``True``.

The ``ForcePasswordChangeMiddleware`` must be installed for this feature to

work properly.

Quick-start

===========

1. Install: ``pip install django-simple-authentication``.

2. Add: ``simple_authentication`` to ``INSTALLED_APPS``.

3. Add: ``AUTH_USER_MODEL = 'simple_authentication'``.

4. Add: ``simple_authentication.middleware.ForcePasswordChanceMiddleware`` to

   ``MIDDLEWARE``.

5. Make migrations: ``python manage.py makemigrations simple_authentication``.

6. Apply migrations: ``python manage.py migrate simple_authentication``.

Compatibility

=============

``django_simple_authentication`` has been tested on Django versions >= 2.0.

It may work without issue on earlier versions of Django (or Python), but

this is not officially supported.

Changelog

=========

+----------------+-----------------------------------------------------------+

| Version        | Description                                               |

+================+===========================================================+

| 0.1.2          | Improved unit test coverage (up to 76%).                  |

+----------------+-----------------------------------------------------------+

| 0.1.1          | Ensure migrations are excluded from the PyPI              |

|                | distribution.                                             |

+----------------+-----------------------------------------------------------+

| 0.1            | Initial version.                                          |

+----------------+-----------------------------------------------------------+