Metadata-Version: 2.1
Name: django-rest-email-manager
Version: 1.0.2
Summary: A Django app to manage user emails.
Home-page: https://github.com/bodgerbarnett/django-rest-email-manager
Author: Simon Barnett
Author-email: sbarnett@acresofspace.co.uk
License: BSD-3-Clause
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
License-File: LICENSE

=============================
django-rest-email-manager
=============================

A Django app to manage user emails.

Documentation
-------------

The full documentation is at https://django-rest-email-manager.readthedocs.io.

Quickstart
----------

Install django-rest-email-manager::

    pip install django-rest-email-manager

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'rest_email_manager',
        ...
    )

Add django-rest-email-manager's URL patterns:

.. code-block:: python

    urlpatterns = [
        ...
        path('email-manager/', include('rest_email_manager.urls')),
        ...
    ]

Create django-rest-email-manager's database tables:

.. code-block:: python

    python manage.py migrate


Features
--------

* REST endpoints for allowing users to change their email address.
* Updated email addresses will require verification before they are set on the user.


