Poetry 使用方法
Poetry 是一个用于管理 Python 项目依赖和包的工具。它简化了项目的依赖管理、包版本控制和发布流程。以下是一些常见的使用方法:
安装 Poetry
首先,你需要安装 Poetry。你可以使用以下命令安装:
curl -sSL https://install.python-poetry.org | python3 -
安装完成后,确保将 Poetry 添加到你的路径中:
export PATH="$HOME/.local/bin:$PATH"
创建项目
要使用 Poetry 创建一个新项目,可以使用以下命令:
poetry new my_project
这将创建一个名为 my_project 的目录,其中包含一个基本的项目结构。
初始化现有项目
如果你已经有一个现有的项目,可以在项目目录中运行以下命令来初始化 Poetry:
poetry init
这将引导你完成创建 pyproject.toml 文件的过程。
添加依赖
你可以使用以下命令来添加项目依赖:
poetry add requests
这将安装 requests 库并将其添加到 pyproject.toml 文件中。
添加开发依赖
如果你需要添加仅用于开发的依赖,可以使用 --dev 选项:
poetry add --dev pytest
安装依赖
要安装 pyproject.toml 文件中列出的所有依赖,可以运行以下命令:
poetry install
更新依赖
你可以使用以下命令更新所有依赖:
poetry update
运行脚本
要使用 Poetry 运行你的 Python 脚本,可以使用以下命令:
poetry run python my_script.py
启动虚拟环境
Poetry 会自动为你的项目创建一个虚拟环境。你可以使用以下命令激活这个虚拟环境:
poetry shell
发布包
当你准备发布你的包时,可以使用以下命令:
poetry publish --build
配置文件
pyproject.toml 是 Poetry 的配置文件,包含了项目的所有依赖和配置。你可以手动编辑这个文件来添加或修改配置。
常用命令汇总
- 创建项目:
poetry new project_name - 初始化项目:
poetry init - 添加依赖:
poetry add package_name - 添加开发依赖:
poetry add --dev package_name - 安装依赖:
poetry install - 更新依赖:
poetry update - 运行脚本:
poetry run python script.py - 启动虚拟环境:
poetry shell - 发布包:
poetry publish --build