Poerty进行Python依赖管理和打包工具

Posted 2020-11-24 erhuabushuo

Poerty

介绍

Poetry是在Python中用来管理依赖和打包用途的工具。它允许声明项目中的依赖，会帮你进行管理（安装/升级）。

系统依赖

需要在 Python 2.7或者3.4+版本中使用。支持多平台，旨在Windows，Linux和OSX相同工作。

安装

curl  -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3

注意：要在shell环境中生效需要执行source $HOME/.poetry/env

Bash自动补全

$ poetry completions bash > poetry.bash-completion
$ sudo mv poetry.bash-completion  /etc/bash_completion.d/

基本用例

为了演示基本用例，我们将使用pendulum，它是一个datetime库。

项目配置

首先，我们创建一个称为poetry-demo的新项目

$ poetry new poetry-demo

该命令会为我们构建一个peotry-demo目录，含有如下文件结构。

├── poetry_demo
│?? └── __init__.py
├── pyproject.toml
├── README.rst
└── tests
    ├── __init__.py
    └── test_poetry_demo.py

最重要的文件是pyproject.toml，它将未你管理项目以及它们的依赖。当前，它内容类似如下:

[tool.poetry]
name = "poetry-demo"
version = "0.1.0"
description = ""
authors = ["Your Name <[e-mail]>"]

[tool.poetry.dependencies]
python = "^2.7"

[tool.poetry.dev-dependencies]
pytest = "^4.6"

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

定义依赖

如果你想在项目中加入依赖，可以在tool.poetry.dependencies区域指定。

[tool.poetry.dependencies]
pendulum = "^1.4"

除了手动修改pyproject.toml文件，你也可以使用add命令。

$ poetry add pendulum

安装依赖

要安装项目中定义的依赖，只需要执行install命令

$ poetry install

制作库

本节将描述如何使用Poetry创建可安装库。

打包

peotry build

提交到PyPI

poetry publish