uv-dynamic-versioning 项目启动与配置教程

1. 项目目录结构及介绍

uv-dynamic-versioning 项目的目录结构如下：

uv-dynamic-versioning/
├── .github/
│   └── workflows/
│       └── v0.7.0.yml
├── docs/
│   └── metadata_hook.md
├── examples/
│   └── example.py
├── src/
│   └── uv_dynamic_versioning/
│       └── __init__.py
├── tests/
│   └── test_versioning.py
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── README.md
├── pyproject.toml
├── requirements.txt
└── uv.lock

• .github/workflows/：存放 GitHub Actions 的配置文件，用于自动化项目的一些流程，如代码审查、构建等。
• docs/：存放项目的文档文件，如元数据钩子（metadata hook）的使用说明。
• examples/：包含示例代码，展示如何使用 uv-dynamic-versioning。
• src/uv_dynamic_versioning/：项目的核心代码目录，包含模块和功能实现。
• tests/：存放测试代码，用于确保项目的功能按预期工作。
• .gitignore：定义了 Git 忽略的文件和目录。
• .pre-commit-config.yaml：配置 pre-commit 钩子，用于在提交代码前自动执行一些格式化任务。
• LICENSE：项目的许可证文件，本项目采用 MIT 许可证。
• README.md：项目的自述文件，包含了项目的基本信息和如何使用。
• pyproject.toml：定义了项目的构建系统和依赖项。
• requirements.txt：存放项目运行所需的依赖库。
• uv.lock：uv 工具的锁文件，用于记录依赖项的精确版本。

2. 项目的启动文件介绍

项目的启动主要是通过 pyproject.toml 文件配置的。pyproject.toml 文件定义了项目的构建系统和所需的依赖项。以下是一个简化的示例：

[build-system]
requires = [
    "hatchling",
    "uv-dynamic-versioning"
]
build-backend = "hatchling.build"

这里，build-system 指定了项目使用的构建系统和依赖，build-backend 定义了后端构建工具。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 和 .pre-commit-config.yaml 进行。

• pyproject.toml：除了指定构建系统和依赖项外，还可以定义项目的元数据和插件。例如，项目中使用了 uv-dynamic-versioning 插件来动态设置版本号。

• .pre-commit-config.yaml：配置 pre-commit 钩子，以下是一个配置示例：

version: 0.12.0
recipes:
  - id: black
    name: isort
    entry: isort
    language: system

这里配置了一个 pre-commit 钩子，用于在代码提交前运行 isort 工具，对 Python 代码中的导入语句进行排序。

以上是 uv-dynamic-versioning 项目的启动和配置文档。通过阅读本教程，您应该能够了解项目的目录结构，以及如何启动和配置项目。