Metadata-Version: 2.3
Name: django-improved-user
Version: 3.0.0rc1
Summary: Compose new Django User models that follow best-practices for international names and authenticate via email instead of username.
Author: Russell Keith-Magee, Andrew Pinkham
License: BSD 2-Clause License
         
         Copyright (c) 2016-2024 Andrew Pinkham
         All rights reserved.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         * Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
         
         * Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Requires-Dist: django>=4.2
Requires-Dist: factory-boy>=2.9 ; extra == 'factory'
Requires-Dist: faker>=0.8 ; extra == 'factory'
Requires-Dist: python-dateutil>=2.6 ; extra == 'factory'
Requires-Python: >=3.10
Project-URL: Documentation, https://django-improved-user.rtfd.io
Project-URL: Source, https://github.com/jambonrose/django-improved-user/
Project-URL: Tracker, https://github.com/jambonrose/django-improved-user/issues
Provides-Extra: factory
Description-Content-Type: text/x-rst

Latest Release: |Version| |Tag|

Documentation: |StableDocs|

Compatibility: |Python| |Django| |License| |Black|

Tests: |Pre-commit| |Coverage|

.. |Version| image:: https://img.shields.io/pypi/v/django-improved-user
		:target: https://pypi.org/project/django-improved-user/
		:alt: PyPI Version

.. |Tag| image:: https://img.shields.io/github/v/tag/jambonrose/django-improved-user
		:target: https://github.com/jambonrose/django-improved-user/releases
		:alt: Github Tag

.. |StableDocs| image:: https://readthedocs.org/projects/django-improved-user/badge/?version=stable
		:target: https://django-improved-user.readthedocs.io/en/stable/?badge=stable
		:alt: Stable Documentation Status

.. |Python| image:: https://img.shields.io/pypi/pyversions/django-improved-user
		:target: https://pypi.org/project/django-improved-user/
		:alt: Python Support

.. |Django| image:: https://img.shields.io/pypi/frameworkversions/django/django-improved-user
		:target: https://pypi.org/project/django-improved-user/
		:alt: Django Support

.. |License| image:: https://img.shields.io/pypi/l/django-improved-user
		:target: http://opensource.org/licenses/BSD-2-Clause
		:alt: License

.. |Pre-commit| image:: https://results.pre-commit.ci/badge/github/jambonrose/django-improved-user/development.svg
		:target: https://results.pre-commit.ci/latest/github/jambonrose/django-improved-user/development
		:alt: pre-commit.ci status

.. |Coverage| image:: https://codecov.io/gh/jambonrose/django-improved-user/branch/development/graph/badge.svg
		:target: https://codecov.io/gh/jambonrose/django-improved-user
		:alt: Coverage Status

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000
		:target: https://github.com/psf/black

.. end-badges

Read Me
=======

This project provides a custom user model that improves on Django's
default by making a few modern and international changes.

* Uses email as the username to simplify login for users
* Replace :code:`first_name` and :code:`last_name` with international
  friendly :code:`short_name` and :code:`full_name` fields

The project also provides mix-in classes to make building custom User
models easier.

For an explanation of why and how the project was built, please see the
`Project Rationale`_.

For information about getting started, please refer to the `quickstart
documentation`_.

For information about how to help with the project, please see the
`contributing documentation`_.

.. _contributing documentation: https://django-improved-user.readthedocs.io/en/latest/contributing.html
.. _Project Rationale: https://django-improved-user.readthedocs.io/en/latest/rationale.html
.. _quickstart documentation: https://django-improved-user.readthedocs.io/en/latest/quickstart.html
