how to use pyproject.toml
时间: 2024-10-12 14:04:06 浏览: 9
Pyproject.toml 是 Python 项目的一个配置文件,它主要用于管理项目依赖、工具链和其他元数据。以下是创建并使用 pyproject.toml 的基本步骤:
1. **新建项目时创建**:
- 如果你在使用 `poetry` 或 `pipenv` 这样的包管理工具,它们会自动为你创建一个 `pyproject.toml` 文件。如果没有,你可以手动创建一个。
2. **打开编辑**:
使用文本编辑器(如 Visual Studio Code,Atom,Sublime Text 等)打开 `pyproject.toml` 文件。
3. **添加基本信息**:
```toml
[project]
name = "your_project_name"
version = "0.1.0"
description = "A brief description of your project."
python = ">=3.7" # 限制Python版本
```
4. **管理依赖**:
- `[dependencies]` 部分用于列出项目的外部依赖,例如:
```toml
[dependencies]
requests = {version = ">=2.25.1"}
numpy = {version = "^1.20"}
```
- 对于开发依赖,可以放在 `[dev-dependencies]` 中。
5. **设置工具配置**:
- 如果有特定的构建工具(如 `build-system`),可以在 `[build-system]` 配置其信息:
```toml
[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"
```
6. **保存并更新**:
保存文件后,可以通过命令行操作来安装或更新依赖:
- `poetry install` (如果使用 poetry)
- `pip install -r requirements.txt` (如果使用 pip)