Poetry 是一个用于依赖管理和打包的工具,它让创建和管理 Python 项目变得更加简单。以下是如何使用 Poetry 创建和管理 Python 项目的步骤。
安装 Poetry
首先,你需要安装 Poetry。你可以使用官方提供的安装脚本来安装 Poetry:
curl -sSL https://install.python-poetry.org | python3 -
或者使用 pip:
pip install poetry
完成安装后,可以使用以下命令验证安装是否成功:
poetry --version
创建新项目
使用 Poetry 创建新项目非常简单。你可以使用以下命令创建一个新的 Poetry 项目:
poetry new my_project
这将创建一个名为 my_project
的新目录,目录结构类似于:
my_project/
├── pyproject.toml
├── README.rst
├── my_project
│ └── __init__.py
└── tests└── __init__.py
pyproject.toml
文件是项目的配置文件,包含了项目的元数据和依赖信息。
在现有项目中使用 Poetry
如果你已经有一个现有的项目,你可以在项目目录中运行以下命令来初始化 Poetry:
cd existing_project
poetry init
这将启动一个交互式向导,帮助你创建 pyproject.toml
文件。
添加依赖
你可以使用 poetry add
命令来添加项目依赖。例如,要添加 requests
库作为依赖,你可以运行:
poetry add requests
poetry add
命令会自动更新 pyproject.toml
和 poetry.lock
文件,并安装新的依赖。
安装项目依赖
如果你想安装所有的项目依赖,可以运行:
poetry install
这将根据 poetry.lock
文件中的信息安装项目的所有依赖。
管理开发依赖
如果你想添加仅在开发时使用的依赖,可以使用 --dev
选项:
poetry add --dev pytest
运行脚本
Poetry 还允许你在虚拟环境中运行脚本。你可以使用 poetry run
命令来运行 Python 脚本或命令。例如:
poetry run python my_project/main.py
发布项目
当你准备好发布你的项目时,可以使用以下命令来构建项目:
poetry build
这将生成 .tar.gz
和 .whl
文件,你可以将它们上传到 PyPI 或其他包管理平台。
发布到 PyPI
如果你已经配置了 PyPI 的凭证,可以使用以下命令来发布项目:
poetry publish
你也可以指定选项来发布到 TestPyPI 或使用不同的凭证。
总结
Poetry 提供了一种简洁的方法来管理 Python 项目的依赖和打包工作。通过使用 Poetry,你可以轻松地创建新项目、管理依赖、运行脚本和发布项目。希望这个指南对你有所帮助!