django-modern-user 0.2.1

An improved custom user model for django projects

Django Modern User

Django Modern User is a custom user model for Django projects that replaces the default username field with a case-insensitive email field for authentication, and removes the requirement for first and last names. This model aims to provide a more practical and modern approach to user management in Django.

Installation

[!IMPORTANT] The instructions below are intended for integrating django-modern-user into new projects. Incorporating this package into existing projects, especially those with existing user data, can be complex and requires careful database migrations and potentially some code adjustments. The integration into projects with existing users is beyond the scope of this documentation.

1. Install django-modern-user via pip:

   python -m pip install django-modern-user
   

2. Add django_modern_user to your INSTALLED_APPS in your Django settings:

   INSTALLED_APPS = [
       # ... other apps
       'django_modern_user',
   ]
   

3. Set django_modern_user.ModernUser as your user model:

   AUTH_USER_MODEL = "django_modern_user.ModernUser"
   

4. To use the provided ModernUserAdmin class in your Django admin site, import ModernUserAdmin and ModernUser from django_modern_user in your admin.py file:

   from django_modern_user.admin import ModernUserAdmin
   from django_modern_user.models import ModernUser
   from django.contrib import admin
   
   admin.site.register(ModernUser, ModernUserAdmin)
   

5. Run migrations to create the necessary database table:

   python manage.py migrate
   

Usage

With django-modern-user, authentication is done using the email field. The email field is case-insensitive, ensuring a user-friendly authentication process.

Here's an example of how you might create a new user:

from django_modern_user.models import ModernUser

# Create a new user
user = ModernUser.objects.create_user(email='[e-mail]', password='password123')

# Create a superuser
superuser = ModernUser.objects.create_superuser(email='[e-mail]', password='password123')

Custom User Manager

django-modern-user comes with a custom user manager, UserPlusManager, which handles user creation and ensures the email field is used for authentication.

Further Customization

You can further customize the ModernUser model and UserPlusManager to meet the specific needs of your project.

Contributing

Feel free to fork the project, open a PR, or submit an issue if you find bugs or have suggestions for improvements.

License

This project is licensed under the MIT License. See the LICENSE file for details.