Metadata-Version: 2.1
Name: django-email-auth-backend
Version: 1.0.0
Summary: Django app supporting email-based authentication.
Author: David Nugent
Author-email: davidn@uniquode.io
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: django (>=3.1)
Description-Content-Type: text/markdown

# django-email-auth
A simple Django app to authenticate users via email (or username).

## Installation

1. Add the package to the project in the usual way according to your project toolset (pip, poetry, pyenv, uv, etc.).
2. Add the following to your `INSTALLED_APPS` setting:
```python
INSTALLED_APPS = [
    ...
    'email_auth',
    ...
]
```
3. Add the `AUTHENTICATION_BACKENDS` setting:
```python
AUTHENTICATION_BACKENDS = [
    'django_email_auth.backend.EmailAuthBackend',
]
```

You can now use either your email OR username to log in.

