manage_django_project

开发 Django 项目的辅助工具

• 轻松启动虚拟环境
  • 只需获取源代码并调用 ./manage.py
  • 只需要 python3-pip 和 python3-venv 软件包即可启动
• 所有 Django manage 命令都可作为常规 CLI 和通过 cmd2 shell 使用
• cmd2 shell 可自动完成所有现有的 manage 命令和所有选项
• 自动在 local 和 tests 设置之间切换 Django 设置。
• 开发时有用的 manage 命令

包含的 Django manage 命令

• code_style - 检查/修复项目代码风格
• coverage - 使用覆盖率运行测试并报告
• install - 仅通过 pip 将项目安装为可编辑的（如果版本已更改，则很有用）
• pip_audit - 使用 pyproject.toml 中的配置运行 pip-audit
• playwright - 调用 playwright CLI
• project_info - 当前 Django 项目的信息
• publish - 构建新版本并将其发布到 PyPi
• run_dev_server - 设置测试项目并运行 django 开发者服务器
• shell - 进入带有所有已注册 Django manage 命令的 cmd2 shell
• tox - 通过 tox 运行测试
• update_req - 通过 pip-tools 更新项目需求
• update_test_snapshot_files - 更新所有快照文件（通过删除并重新创建所有快照文件）

如何使用

使用 manage_django_project 在您的项目中需要一些步骤。

以下是一个概述和详细信息

• 将 manage_django_project 添加到您的开发依赖中
• 您的 Django 项目应该有针对 prod、local 和 tests 的单独设置（后两个由 manage_django_project 使用）
• 添加 bootstrap manage.py
• 添加一个包含 execute_django_from_command_line() 调用的 __main__.py
• 在您的 pyproject.toml 中
  • 添加 [manage_django_project] 部分
  • 将__main__文件添加到[project.scripts]
• 将你的[project.scripts]名称添加到bootstrap manage.py

以下所有示例都使用了manage_django_project_example。你必须将此字符串/路径重命名为你的Django包名。

完整示例在此：https://github.com/jedie/manage_django_project/tree/main/manage_django_project_example

如果一切按预期工作，你只需调用./manage.py文件，魔法就会发生 ;)

main.py

添加一个.../manage_django_project_example/__main__.py文件，看起来像

from manage_django_project.manage import execute_django_from_command_line


def main():
    """
    entrypoint installed via pyproject.toml and [project.scripts] section.
    Must be set in ./manage.py and PROJECT_SHELL_SCRIPT
    """
    execute_django_from_command_line()


if __name__ == '__main__':
    main()

pyproject.toml

[project.scripts]
manage_django_project_example = "manage_django_project_example.__main__:main"

[manage_django_project]
module_name="your_project_example"

# Django settings used for all commands except test/coverage/tox:
local_settings='your_project.settings.local'

# Django settings used for test/coverage/tox commands:
test_settings='your_project.settings.tests'

./manage.py

将manage.py文件的副本添加到你的项目源根目录。

只更改此行中的manage_django_project_example

PROJECT_SHELL_SCRIPT = BIN_PATH / 'manage_django_project_example'

开始编写代码

只需克隆项目并开始./manage.py以引导虚拟环境

# Install base requirements:
~$ sudo apt install python3-pip python3-venv

# Get the sources:
~$ git clone https://github.com/jedie/manage_django_project.git
~$ cd manage_django_project/

# Just call manage.py and the magic happen:
~/manage_django_project$ ./manage.py

# start local dev. web server:
~/django-for-runners$ ./manage.py run_dev_server

# run tests:
~/django-for-runners$ ./manage.py test
# or with coverage
~/django-for-runners$ ./manage.py coverage
# or via tox:
~/django-for-runners$ ./manage.py tox

不兼容的更改

v0.2.x -> v0.3.x

配置已从__main__.py移动到pyproject.toml

你必须在pyproject.toml中添加以下内容

[manage_django_project]
module_name="your_project_example"

# Django settings used for all commands except test/coverage/tox:
local_settings='your_project.settings.local'

# Django settings used for test/coverage/tox commands:
test_settings='your_project.settings.tests'

从execute_django_from_command_line()中删除了config参数，因此你的__main__.py必须看起来像

from manage_django_project.manage import execute_django_from_command_line


def main():
    execute_django_from_command_line()


if __name__ == '__main__':
    main()

发布新版本

我们使用cli-base-utilities在README中生成历史记录。

要发布新版本，请执行以下操作

• 增加你的项目版本号
• 运行测试以更新README
• 提交更改
• 创建发布

历史记录

• v0.8.0
  • 2024-08-02 - 将“safety”替换为“pip-audit”并添加相关工具。
  • 2024-08-02 - 更新项目设置
  • 2024-08-02 - 更新要求和添加git预提交钩子
  • 2024-05-21 - 更新要求
  • 2024-05-21 - 安全性：忽略CVE-2018-20225
  • 2024-05-21 - 从manageprojects模板更新
• v0.7.2
  • 2024-02-20 - 将“--strip-extras”添加到pip-compile并更新要求
• v0.7.1
  • 2024-01-18 - 在测试中使用typeguard
  • 2024-01-18 - 更新要求
  • 2024-01-18 - manageprojects更新 + 设置最小Python为3.9
• v0.7.0
  • 2023-12-19 - 应用manageprojects：扩展测试矩阵 + 更新要求 + 跳过Python 3.9
  • 2023-12-19 - 为unittests设置django
  • 2023-12-16 - 修复代码风格错误
  • 2023-12-16 - 使用update_readme_history &作为git钩子
  • 2023-11-07 - 更新要求