You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
iTi-Flask/docs/COPIER_TEMPLATE.md

1.3 KiB

Copier 模板

copier-template 用于生成业务后端项目。 模板只生成项目骨架,不复制框架源码。

生成项目

在 iTi-Flask 仓库根目录执行:

uvx copier copy ./copier-template ../my-business-app

进入生成后的项目:

cd ../my-business-app
uv sync --extra dev
uv run python -m flask --app app.py db upgrade
uv run python -m flask --app app.py run --debug

模板参数

参数 说明
project_name 业务项目显示名称
project_slug 业务项目 Python 包名
framework_git iTi-Flask Git 地址
framework_tag iTi-Flask Git tag
include_system 是否引入 iTi-System
system_git iTi-System Git 地址
system_tag iTi-System Git tag

生成内容

模板会生成:

  • app.py
  • config.py
  • pyproject.toml
  • migrations/
  • 业务 Python 包。
  • 示例模块。
  • 示例模型。
  • 示例测试。

扩展方式

业务项目扩展框架时,只改业务项目自己的文件:

  • modules/ 下新增业务模块。
  • models/ 下新增业务模型。
  • config.py 中覆盖配置。
  • app.py 中注册模块和模型导入函数。

框架升级通过更新 pyproject.toml 中的 Git tag 完成。