使用pyproject来管理python项目

July 26, 2024

pyproject.toml 是一个配置文件，用于标准化 Python 项目的构建系统和依赖声明。以下是如何使用 pyproject.toml 来管理项目的依赖和版本控制的步骤：

1. 创建 `pyproject.toml` 文件

在你的项目根目录下创建一个名为 pyproject.toml 的文件。这个文件将包含项目的元数据和依赖信息。

2. 配置项目元数据

在 pyproject.toml 文件中，你可以指定项目的名称、版本、作者、许可证等信息。例如：

1
2
3
4
5
6
7


[project]
name = "your-project-name"
version = "0.1.0"
description = "A short description of your project"
authors = ["Your Name <your.email@example.com>"]
license = "MIT"
requires-python = ">=3.8"

3. 声明依赖项

在 [project.dependencies] 部分，列出项目运行所需的所有依赖项及其版本范围。例如：

1
2
3


[project.dependencies]
requests = "^2.25.1"
numpy = ">=1.19.5,<2.0"

这里使用了版本范围来指定依赖项的兼容版本。

4. 可选依赖项

如果你的项目有可选功能，可以在 [project.optional-dependencies] 下声明这些依赖。例如：

1
2


[project.optional-dependencies]
asyncio = ["aiohttp"]

5. 使用条件依赖

pyproject.toml 支持条件依赖，这意味着依赖项可以根据操作系统或 Python 版本进行条件性安装。例如：

1
2
3


[project.dependencies]
"django>2.1" = { version = ">=2.1", markers = "os_name != 'nt'" }
"django>2.0" = { version = ">=2.0", markers = "os_name == 'nt'" }

6. 配置构建系统

在 [build-system] 部分，指定所需的构建工具和后端。例如，使用 setuptools 和 wheel：

1
2
3


[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

7. 使用 `poetry` 自动化依赖管理

如果你使用 poetry 作为依赖管理工具，pyproject.toml 将由 poetry 自动维护。你只需添加或更新依赖项，然后运行 poetry update 来更新 pyproject.toml 和 poetry.lock 文件。

8. 安装依赖项

使用 pip 来安装 pyproject.toml 中声明的依赖项：

1

pip install .

或者，如果你想使用特定的依赖项配置（例如可选依赖项），可以使用以下命令：

1

pip install .[asyncio]

9. 锁定依赖项版本

为了确保在不同环境中使用相同版本的依赖项，可以使用 poetry lock 或 pip freeze 命令来锁定依赖项的版本。poetry 会生成 poetry.lock 文件，而 pip 会生成 requirements.txt 文件。

10. 分享和协作

当其他开发者或用户想要安装或使用你的项目时，他们只需要一个 pyproject.toml 文件即可安装所有必要的依赖项，确保项目的一致性和可复现性。

通过上述步骤，你可以使用 pyproject.toml 来有效地管理 Python 项目的依赖和版本控制，提高项目的可维护性和可扩展性。pyproject.toml 是 Python 项目中用于管理依赖和元数据的配置文件，与 setup.py 类似，但更加现代化和易于使用。

以下是一些使用 pyproject.toml 管理项目的教程和指南：

Python项目打包与部署：这个系列教程详细介绍了如何使用 pyproject.toml 进行项目依赖管理，包括使用 requirements.txt 和 pip-compile 等工具。pyproject.toml 中的 [project] 部分用于配置项目的依赖项，可选依赖项，以及指定项目所需的 Python 版本。
为Python项目启用poetry和pyproject.toml：这篇博客介绍了如何使用 poetry 来初始化项目，并自动生成 pyproject.toml 文件。poetry 是一个依赖管理和打包工具，可以方便地在 pyproject.toml 中声明依赖关系，并创建虚拟环境。
Python 如何使用pyproject.toml设置和poetry运行脚本：这里介绍了如何结合使用 pyproject.toml 和 poetry 来运行 Python 脚本。通过 poetry 可以安装依赖项，并使用 poetry run 命令来执行脚本。
Python 新规范 pyproject.toml 完全解析：这篇文章深入解析了 pyproject.toml 的结构和用法，包括如何配置项目元数据、依赖关系以及可选依赖项。文章还提供了一个示例项目结构和 pyproject.toml 文件的内容。
Pyproject-新一代python项目管理工具：这篇博客讨论了 pyproject.toml 的目的和好处，即集中管理项目配置，简化项目结构。示例中展示了如何在 pyproject.toml 中配置构建系统、项目依赖和可选依赖。
快速上手 - Python 项目工程化开发指南：这是一个快速上手指南，通过一个单词统计的示例项目，展示了使用 pyproject.toml 和 poetry 进行 Python 项目开发的标准流程。指南涵盖了从项目初始化到环境搭建，再到依赖管理和项目测试的全过程。

通过上述教程，你可以学习如何使用 pyproject.toml 来管理 Python 项目的依赖和配置，以及如何结合现代工具如 poetry 来优化开发流程。

1. 创建 pyproject.toml 文件