Django REST Framework Guardian 项目教程

Django REST Framework Guardian 项目教程

django-rest-framework-guardian django-guardian support for Django REST Framework 项目地址: https://gitcode.com/gh_mirrors/dj/django-rest-framework-guardian

1. 项目目录结构及介绍

django-rest-framework-guardian/
├── circleci/
│   └── ...
├── src/
│   └── rest_framework_guardian/
│       ├── __init__.py
│       ├── filters.py
│       ├── permissions.py
│       └── serializers.py
├── tests/
│   └── ...
├── .gitignore
├── CHANGELOG
├── LICENSE
├── MANIFEST.in
├── README.md
├── manage.py
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• circleci/: 包含 CircleCI 配置文件，用于持续集成。
• src/rest_framework_guardian/: 项目的主要代码目录，包含过滤器、权限和序列化器等模块。
  • init.py: 初始化文件，使该目录成为一个 Python 包。
  • filters.py: 包含用于过滤查询集的过滤器类。
  • permissions.py: 包含自定义权限类，用于控制对象级别的权限。
  • serializers.py: 包含序列化器类，用于对象权限的分配。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
• CHANGELOG: 项目变更日志，记录每个版本的更新内容。
• LICENSE: 项目许可证文件，采用 BSD-3-Clause 许可证。
• MANIFEST.in: 包含需要包含在发布包中的文件列表。
• README.md: 项目说明文件，包含项目的基本信息和使用说明。
• manage.py: Django 项目的管理脚本，用于执行各种管理任务。
• setup.cfg: 包含 setuptools 的配置选项。
• setup.py: 用于构建和分发项目的 Python 脚本。
• tox.ini: 包含 Tox 配置文件，用于自动化测试。

2. 项目启动文件介绍

manage.py

manage.py 是 Django 项目的管理脚本，用于执行各种管理任务。通过该脚本，可以启动开发服务器、创建数据库迁移、运行测试等。

python manage.py runserver

上述命令将启动 Django 开发服务器，默认运行在 http://127.0.0.1:8000/。

3. 项目配置文件介绍

settings.py

settings.py 是 Django 项目的配置文件，包含项目的各种配置选项。以下是与 django-rest-framework-guardian 相关的配置：

INSTALLED_APPS = [
    'rest_framework',
    'guardian',
]

AUTHENTICATION_BACKENDS = [
    'django.contrib.auth.backends.ModelBackend',
    'guardian.backends.ObjectPermissionBackend',
]

配置说明

• INSTALLED_APPS: 包含 rest_framework 和 guardian，确保这两个应用被安装并可用。
• AUTHENTICATION_BACKENDS: 包含 ModelBackend 和 ObjectPermissionBackend，用于支持对象级别的权限控制。

setup.py

setup.py 是用于构建和分发项目的 Python 脚本。通过该脚本，可以将项目打包并上传到 PyPI。

python setup.py sdist bdist_wheel
twine upload dist/*

上述命令将构建项目的源代码分发包和 wheel 包，并上传到 PyPI。

tox.ini

tox.ini 是 Tox 的配置文件，用于自动化测试。通过 Tox，可以在多个 Python 版本和环境中运行测试。

tox

上述命令将根据 tox.ini 中的配置，在不同的环境中运行项目的测试。

django-rest-framework-guardian django-guardian support for Django REST Framework 项目地址: https://gitcode.com/gh_mirrors/dj/django-rest-framework-guardian