uv-dynamic-versioning 的安装和配置教程

uv-dynamic-versioning 是一个用于 uv/hatch 项目的动态版本管理工具，基于版本控制系统（VCS）的标签来动态设置版本。它主要使用 Python 编程语言，并且与 hatch 构建系统紧密集成。

项目的基础介绍和主要的编程语言

uv-dynamic-versioning 是一个开源项目，旨在为使用 uv 或 hatch 的项目提供动态版本管理功能。它允许开发者在版本发布时，基于 Git 标签自动更新项目版本号。该项目的主要编程语言是 Python，它利用了 Python 的动态性和广泛的模块生态。

项目使用的关键技术和框架

uv-dynamic-versioning 使用了以下关键技术和框架：

• dunamai：用于检索和解析版本信息。
• hatch：一个用于构建、打包和发布 Python 项目的工具。
• Git：版本控制系统，用于管理代码和标签。

项目安装和配置的准备工作和详细的安装步骤

在开始安装 uv-dynamic-versioning 之前，请确保您的系统中已经安装了以下软件：

• Python 3.7 或更高版本
• Git
• hatch

以下是小白级安装和配置的详细步骤：

步骤 1：安装依赖

首先，确保您的系统中已经安装了 Python 和 Git。接下来，在命令行中执行以下命令来安装 hatch 和 uv-dynamic-versioning：

pip install hatchling uv-dynamic-versioning

步骤 2：配置项目

在您的项目根目录中，创建或更新 pyproject.toml 文件，以包含 hatch 构建系统和 uv-dynamic-versioning 插件。以下是一个示例配置：

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

[tool.hatch.version-source]
source = "git"

步骤 3：创建版本源插件（可选）

如果需要，您可以创建自定义版本源插件来自定义版本生成的规则。这通常涉及到编写一个 Python 脚本，并在 pyproject.toml 文件中引用。

步骤 4：构建项目

配置完成后，您可以使用 hatch 命令来构建项目。以下命令将构建项目并生成分布包：

hatch build

步骤 5：发布项目

如果您的项目配置了自动化发布，您可以通过 hatch 发布项目到 PyPI：

hatch publish

请确保您已经登录到了 PyPI，并且拥有发布权限。

遵循以上步骤，您可以成功安装和配置 uv-dynamic-versioning，为您的项目带来动态版本管理的便利。