Django Custom User 开源项目推荐

Django Custom User 开源项目推荐

django-custom-userCustom user model for Django with the same behaviour as the default User class but with email instead of username.项目地址:https://gitcode.com/gh_mirrors/dj/django-custom-user

项目介绍

Django Custom User 是一个为 Django 框架设计的自定义用户模型库，它提供了与默认用户类相同的行为，但没有用户名字段。该库使用电子邮件作为用户名进行身份验证，使得用户管理更加灵活和现代化。

项目技术分析

Django Custom User 项目充分利用了 Django 框架的强大功能，通过自定义用户模型，简化了用户身份验证和管理的流程。以下是一些关键技术点：

• 自定义用户模型：通过继承 AbstractEmailUser，开发者可以轻松扩展用户模型，添加自定义字段。
• 电子邮件作为用户名：使用电子邮件作为 USERNAME_FIELD，符合现代用户习惯，简化了用户注册和登录流程。
• 兼容性：支持多个 Django 和 Python 版本，确保广泛的适用性。
• 持续集成：使用 GitHub Actions 进行持续集成，确保代码质量和稳定性。

项目及技术应用场景

Django Custom User 适用于以下场景：

• 现代 Web 应用：需要使用电子邮件作为用户名进行身份验证的应用。
• 用户管理系统：需要灵活扩展用户模型的系统，如社交网络、企业内部系统等。
• 多版本兼容：需要支持多个 Django 和 Python 版本的项目。

项目特点

• 灵活性：通过自定义用户模型，满足各种用户管理需求。
• 现代化：使用电子邮件作为用户名，符合现代用户习惯。
• 兼容性：支持多个 Django 和 Python 版本，确保广泛的适用性。
• 易用性：简单的安装和配置流程，快速集成到现有项目中。

快速开始

1. 安装：使用你喜欢的 Python 包管理器安装 django-custom-user：

   pip install django-custom-user
   

2. 配置：将 'custom_user' 添加到你的 INSTALLED_APPS 设置中：

   INSTALLED_APPS = (
       # other apps
       'custom_user',
   )
   

3. 设置用户模型：将 AUTH_USER_MODEL 设置为使用 EmailUser：

   AUTH_USER_MODEL = 'custom_user.EmailUser'
   

4. 迁移数据库：创建数据库表：

   python manage.py migrate
   

使用示例

在代码中引用用户模型时，应使用 get_user_model() 方法：

from django.contrib.auth import get_user_model

user = get_user_model().objects.get(email="user@example.com")

定义外键或多对多关系时，应使用 AUTH_USER_MODEL 设置：

from django.conf import settings
from django.db import models

class Article(models.Model):
    author = models.ForeignKey(settings.AUTH_USER_MODEL)

扩展用户模型

通过继承 AbstractEmailUser，可以轻松扩展 EmailUser 模型：

from custom_user.models import AbstractEmailUser

class MyCustomEmailUser(AbstractEmailUser):
    date_of_birth = models.DateField()

记得更改 AUTH_USER_MODEL 设置：

AUTH_USER_MODEL = 'my_app.MyCustomEmailUser'

如果使用 AdminSite，添加以下代码到 my_app/admin.py 文件：

from django.contrib import admin
from custom_user.admin import EmailUserAdmin
from .models import MyCustomEmailUser

class MyCustomEmailUserAdmin(EmailUserAdmin):
    pass

admin.site.register(MyCustomEmailUser, MyCustomEmailUserAdmin)

支持版本

• Django：4.1, 4.0, 3.2 LTS
• Python：3.11, 3.10, 3.9, 3.8, 3.7

更新日志

• 版本 1.1 (2022-12-10)：增加对 Django 4.1 和 Python 3.11 的支持。
• 版本 1.0 (2022-03-29)：兼容最新 Django 和 Python 版本，包含多项改进和清理。

结语

Django Custom User 是一个强大且灵活的开源项目，适用于需要自定义用户模型的 Django 应用。通过简单的安装和配置，你可以快速集成并扩展用户管理功能，提升应用的用户体验。快来尝试吧！

django-custom-userCustom user model for Django with the same behaviour as the default User class but with email instead of username.项目地址:https://gitcode.com/gh_mirrors/dj/django-custom-user