用 Poetry 创建并发布 Python 包 _Python

文章插图

如果您曾经使用setup.py脚本发布过一个Python包，那么您可能会发现编写脚本来发布包比编写包本身要困难。
Python 开发人员认识到了这一点，并且有一些工具采用了一种更现代的方法来构建包。Poetry 和 Flit 是构建Python 包的两种流行工具。
（此处已添加圈子卡片，请到今日头条客户端查看）因为我使用了Poetry作为一个Python依赖性管理工具，所以我决定玩转它的包管理功能。
为了获得使用Poetry发布包的实践经验，我最近发布了Flake8 Markdown，一个用 Flake8 在Markdown文件中lint Python 代码的工具。
本文将介绍我对Flake8 Markdown的pyproject.toml和codebase所做的更改，以使其可以在 PyPI（python包索引）上发布。

信息已发布版本请查看Flake8 Markdown 仓库。

创建一个包用 Poetry 创建一个包, 如果 Poetry 已安装，是会有帮助的。要做到这一点，请遵循 Poetry 安装说明。现在，用Poetry 创建一个包，我们将运行 poetry new，并提供包含该包的目录的名称:

文章插图

我们收到邮件了! 不管怎样，我们有一个包裹 (package，双关语---译者注) 。让我们打开它:

文章插图

开箱即用，Poetry为我们提供了一个简单的包结构和 pyproject.toml 文件:

0.1.0的包版本
Python 的最小版本(在我的例子中是^3.7)
pytest 支持和一个单元测试

信息关于 pyproject.toml的信息和背景，见 PEP 518 。

如果我们将这个包按原样发布在 Python包索引(PyPI)上，那么这个包看起来就不怎么样，所以让我们让它看起来像值得安装的东西。
自定义包以下是初始 pyproject.toml文件:

文章插图

以下是完成的 pyproject.toml:

文章插图

信息有关自定义Poetry包的可用部分的完整列表，请参阅 Poetry's pyproject.toml 文档。让我们从上到下逐步进行更改。

version
Version 描述了一个包的当前版本。我尝试遵循语义版本控制，所以当更新向后不兼容时很明显。

注一旦一个包的版本存在于pypi上，就不可能使用相同的版本号上传不同的代码。在发布Pypi上的版本之前，请确保使用 TestPyPI 进行测试更改。

description
这个简短的描述出现在 pip search 和 PyPI搜索结果中。
license
许可证出现在包的 PyPI 页面的“Meta”部分。
我用 Github 的 choosealicense.com 找到了一个合适的许可证，并选定 MIT 。Poetry 还列出了其他常见的许可证和推荐的记号。
readme
Poetry创建了一个 README.rst 文件，但我更喜欢用 Markdown 编写文档。README 的内容在 PyPI 上显示为项目描述，因此很好地解释为什么以及如何使用你的包。我的 README 包括：

盾牌（因为它们看起来很漂亮）
引言
安装
使用
行为准则
历史记录（大致遵循保留一个变更日志）

homepage and repository
这些出现在包的 PyPI 页面的 Project 链接部分：

文章插图

如果你的包有一个单独的文档网站，那么还有一个 documentation 属性。
【用 Poetry 创建并发布 Python 包】keywords
这些出现在 PyPI 页面的 Meta 部分：

文章插图

classifiers
“Trove分类器”作为 PyPI 包的类别，可以用来过滤 PyPI 上的包。它们出现在 PyPI 页面的“分类器”部分：

文章插图

完整列表见 PyPI 分类器页面。
[tool.poetry.dependencies]
“依赖项”部分展示了Poetry的一个最佳特征。
当使用普通的 pip 或 Pipenv管理包时，通常在两个位置指定包：dev和部署依赖项的requirements.txt或Pipfile，以及运行时/安装依赖项的setup.py 。
Poetry对所有依赖项使用pyproject.toml，这简化了依赖项管理。
这部分包括两个更改：