Metadata-Version: 2.1
Name: django-rest-email-auth
Version: 4.0.3
Summary: Django app for email based authentication and registration via a REST API.
License: MIT
Author: Chathan Driehuys
Author-email: chathan@driehuys.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: Django (>=3.2,<5)
Requires-Dist: django-email-utils (>=1,<2)
Requires-Dist: djangorestframework (>=3.10,<4.0)
Description-Content-Type: text/x-rst

######################
django-rest-email-auth
######################

.. image:: https://img.shields.io/github/actions/workflow/status/cdriehuys/django-rest-email-auth/run-tests.yml?branch=master
   :alt: GitHub Workflow Status
   :target: https://github.com/cdriehuys/django-rest-email-auth/actions/workflows/run-tests.yml?query=branch%3Amaster

.. image:: https://img.shields.io/codecov/c/github/cdriehuys/django-rest-email-auth.svg
    :target: https://codecov.io/gh/cdriehuys/django-rest-email-auth

.. image:: https://img.shields.io/pypi/v/django-rest-email-auth.svg
    :target: https://pypi.python.org/pypi/django-rest-email-auth/

***************
Important Links
***************

Project Homepage
  https://github.com/cdriehuys/django-rest-email-auth

Documentation
  https://django-rest-email-auth.readthedocs.io

********
Overview
********

This package provides a simple way to enable authentication with email addresses for a REST API.

Features:
  * Verification of user email addresses
  * Authentication using any of a user's verified email addresses
  * Registration of new users
  * Password resets using verified emails

*************
Compatibility
*************

| **Python:** 3.6 or later
| **Django:** Versions 3.2 through 4.1
| **Django REST Framework:** 3.14 or later

***************
Adding Features
***************

This package was primarily developed for a single project's use. As such it may lack features that other projects require. If that is the case, please `open an issue <open-issue_>`_ and let us know.

*******
License
*******

This project is licensed under the MIT License.

*******
Authors
*******

Chathan Driehuys (chathan@driehuys.com)


.. _open-issue: https://github.com/cdriehuys/django-rest-email-auth/issues/new

