Metadata-Version: 1.1
Name: django-use-email-as-username
Version: 1.0.0
Summary: A Django app to use email as username for user authentication.
Home-page: https://github.com/jmfederico/django-use-email-as-username
Author: Federico Jaramillo Martínez
Author-email: federicojaramillom@gmail.com
License: BSD License
Description-Content-Type: UNKNOWN
Description: ============================
        Django use Email as Username
        ============================
        
        .. image:: https://badge.fury.io/py/django-use-email-as-username.svg
            :target: https://badge.fury.io/py/django-use-email-as-username
        
        .. image:: https://travis-ci.org/jmfederico/django-use-email-as-username.svg?branch=master
            :target: https://travis-ci.org/jmfederico/django-use-email-as-username
        
        .. image:: https://codecov.io/gh/jmfederico/django-use-email-as-username/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/jmfederico/django-use-email-as-username
        
        A Django app to use email as username for user authentication.
        
        
        Features
        --------
        
        * Custom User model with no username field
        * Use email as username
        * Includes a django-admin command for quick install
        * Follow Django `best practices`_ for new Django projects and User models.
        
        .. _`best practices`: https://docs.djangoproject.com/en/dev/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project
        
        
        Quickstart
        ----------
        
        1. Install **Django use Email as Username**::
        
            $ pip install django-use-email-as-username
        
        2. Add it to your *INSTALLED_APPS*::
        
            INSTALLED_APPS = (
                ...
                'django_use_email_as_username.apps.DjangoUseEmailAsUsernameConfig',
                ...
            )
        
        3. Create you new django app::
        
            $ python manage.py create_custom_user_app
        
        4. Add the new app to your *INSTALLED_APPS*::
        
            INSTALLED_APPS = (
                ...
                'django_use_email_as_username.apps.DjangoUseEmailAsUsernameConfig',
                'custom_user.apps.CustomUserConfig',
                ...
            )
        
        5. Now instruct Django to use your new model::
        
            AUTH_USER_MODEL = 'custom_user.User'
        
        6. Create and run migrations::
        
            $ python manage.py makemigrations
            $ python manage.py migrate
        
        You now have a new Django app which provides a custom User model.
        
        You can further modify the new User Model any time in the future, just remember
        to create and run the migrations.
        
        
        Notes
        -----
        
        This app gives you a custom User model, which is `good practice`_ for new
        Django projects.
        
        `Changing to a custom user model mid-project`_ is not easy.
        
        .. _`good practice`: https://docs.djangoproject.com/en/dev/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project
        .. _`Changing to a custom user model mid-project`: https://docs.djangoproject.com/en/dev/topics/auth/customizing/#changing-to-a-custom-user-model-mid-project
        
        It is recommended to always create a custom User model at the beginning of every
        Django project.
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `Cookiecutter Django Package`_ by jmfederico_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`Cookiecutter Django Package`: https://github.com/jmfederico/cookiecutter-djangopackage
        .. _jmfederico: https://github.com/jmfederico
        
        
        
        
        History
        -------
        
        1.0.0 (2018-02-18)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: django-use-email-as-username
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
