gdmty-django-users 24.5.0

Extension of Django's AbstractBaseUser for user management, using email as user.

gdmty-django-users

The app gdmty-django-users package is a Django extension that builds upon the abstract AbstractBaseUser class for use e-mail as user. And has the option to authenticate with reCaptcha token verification.

The project is maintained by Gobierno de Monterrey. You can find more about the project on its homepage or report issues on the bug tracker.

Features

• Email-based User Identification: Utilizes email addresses as identifier for users.
• Custom User Model: Extends Django's AbstractBaseUser to provide custom user functionality.
• Modular Design: Designed as a reusable Django app for easy integration into projects.
• Compatibility with Python 3.9 and later, and Django 4.1.13 and later.

Installation

$ pip install gdmty-django-users

Configuration

Add the application to your project's INSTALLED_APPS in settings.py also add the DRF_ROUTER variable.

from rest_framework import routers

INSTALLED_APPS = [
    # ...
    'gdmty_django_users',
    ...
]
DRF_ROUTER = routers.DefaultRouter()  # Necessary for the gdmty_django_users package

An example to use in your 'models.py file:

from gdmty_django_users.models import User

from django.db import models

class MyModel(models.Model):
    user = User.ForeignKey(User, on_delete=User.CASCADE)

Contributing

• Please raise an issue/feature and name your branch 'feature-n' or 'issue-n', where 'n' is the issue number.
• If you test this code with a Python or package version not listed above and all is well, please fork and update the README to include the Python version you used :)

Additional Notes

• This project is maintained by Gobierno de Monterrey.
• The project's homepage is here and issues can be reported here.