利用 poetry 打包 python 模块发布到 pypi

最新推荐文章于 2024-03-06 14:09:16 发布
最新推荐文章于 2024-03-06 14:09:16 发布
阅读量2.4k 收藏 6
点赞数
分类专栏： Python 编程进阶 文章标签： python poetry pypi 项目打包 项目管理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Likianta/article/details/107888956
版权

前述

不少人应该对 Python 打包心存阴影, 不同于 Go 与 Rust 在项目打包时的快感, Python 的打包系统和依赖管理比较复杂, setup.py, requirements.txt, setup.cfg, MANIFEST.in, Pipfile and Pipfile.lock (pipenv) 等诸多文件需要我们考虑 (https://learnku.com/python/t/38708).

那么有没有 all-in-one 的项目打包工具呢? 这里我使用 poetry 满足了这个需求.

本文将介绍使用 poetry 打包项目并发布到 PyPI 的过程, 以我自用的 lk-utils 为例进行讲解.

本方法在 2020年8月8日 测试可行, 以下是本人完整的实现流程.

准备

  1. 我的项目结构如下:
D:\workspace\lk-utils
|- changelog  # 这里存放了我的更新日志文件.
|- lk_utils  # 这是我要打包的模块主体.
    |- resources  # 我的项目中用到了一些资源文件, 传统的打包方式会有诸多细节要注
    |             # 意; 不过使用 poetry 就简单得多了, 后面会讲到.
    |- __init__.py
    |- lk_logger.py
    |- ...
|- README.md  # 自述文档.

  1. 由于我访问 pypi 仓库速度慢 (有时候会超时), 所以我使用了清华镜像 (https://pypi.tuna.tsinghua.edu.cn/simple/).

  2. poetry 模块已通过 pip install poetry 安装.

Poetry Init

在命令行终端, 输入 poetry init:

在这里插入图片描述

在命令行中, poetry 会出现引导信息, 需要和你交互确认:

> This command will guide you through creating your pyproject.toml config.
> Package name [lk-utils]: lk-utils  # 这里我填写项目名为 "lk-utils", 在上传到 pypi 后, 可通过 `pip install lk-utils` 安装此模块.
> Version [0.1.0]: 1.2.11  # 留空的话, 则会使用中括号里的缺省值.
> Description []:  # 我没有填写项目描述, 所以回车跳过. (后期是可修改的)
> Author [Likianta <likianta@foxmail.com>, n to skip]:  # 同样回车使用缺省值.
> License []:  MIT
> Compatible Python versions [^3.8]: ^3.6  # 假设支持 Python 3.6 以上版本.
> Would you like to define your main dependencies interactively? (yes/no) [yes]: no  # 这一步询问我们是否现在填写项目依赖, 考虑到 poetry 默认查询的是 pypi 仓库, 很容易访问不了或连接超时 (然后就会报错中断). 所以我们填 no 先跳过.
> Would you like to define your development dependencies interactively? (yes/no) [yes]: no  # 这一步询问我们是否现在填写开发时依赖, 同样填 no 跳过.
> Do you confirm generation? (yes/no) [yes]: yes  # 至此, 引导操作完成.

(注: 如对上述命令有不清楚的地方, 比如为什么缺省的版号是从 “0.1.0” 开始, “^3.6” 的尖角符号是什么意思等, 欢迎阅读 初次使用 python poetry 包管理模块踩坑 一文了解.)

根据 poetry 的引导完成操作后, 在项目目录下会出现一个 “pyproject.toml” 文件:

在这里插入图片描述

toml 文件是一个配置文件 (类似于 json, yaml). 接下来我们要在 toml 文件中配置清华镜像和项目依赖.

编辑 pyproject.toml 配置

[tool.poetry]
name = "lk-utils"
version = "0.1.0"
description = ""
authors = ["Likianta <likianta@foxmail.com>"]
license = "MIT"

# 添加清华镜像
[[tool.poetry.source]]
name = "tsinghua"
url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple/"
default = true  # 设置清华镜像为默认回调, 以避免 poetry 在某些缺省操作里又回调到 pypi 仓库.

# 在这里添加项目依赖.
# 1. 我没研究清楚 poetry 如何自动解析项目依赖 (听说 poetry 的解析很慢), 所以这些依赖是我人眼过了一遍项目源码后自己加的.
# 2. 只需要添加自己 `import` 时引用了哪些第三方依赖, 不需要写明依赖的依赖.
# 3. 版本号规则:
# 3.1. "^2.24.0" 表示 "2.24.0 ~ 3.0.0" 区间 (左边是大于等于, 右边是小于).
# 3.2. "~2.24.0" 表示 "2.24.0 ~ 2.25.0" 区间 (左边是大于等于, 右边是小于).
# 3.3. "*" 表示任意版本号, poetry 会优先选取最新版.
# 3.4. 更多规则请见 https://python-poetry.org/docs/dependency-specification/#version-constraints
# 4. 有些依赖虽然用到了, 但我没写进去, 一是因为这些依赖只在特定的方法中才被调用了一两次, 二是为了瘦身考虑.
[tool.poetry.dependencies]
python = "^3.6"
bs4 = "^0.0.1"
lxml = "^4.5.0"
requests = "^2.24.0"
xlrd = "^1.2.0"
xlsxwriter = "^1.2.7"
# csv = "*"
# pdfminer = "*"
# pdfplumber = "*"
# pypinyin = "*"

# 在这里添加项目开发时依赖.
[tool.poetry.dev-dependencies]

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

PS: 如果你不确定版本号具体是多少, 可以通过 poetry update 来自动检查并更新 pyproject.toml 的依赖版本到最新.

Poetry Install (非必须, 可跳过此节)

运行 poetry install, 可生成 “poetry.lock” 文件. “poetry.lock” 对于发布到 pypi 的模块来说不是必须的, 如需了解请阅读: https://python-poetry.org/docs/basic-usage/

Poetry Build

在发布到 pypi 之前, 我们需要先运行一下 poetry build. 此时项目目录下会生成 dist 文件夹:

D:\workspace\lk-utils
|- changelog
|- dist  # 生成了 dist 文件夹
    |- lk-utils-1.2.11.tar.gz
    |- lk_utils-1.2.11-py3-none-any.whl
|- lk_utils
|- pyproject.toml
|- README.md

Poetry Publish

运行 poetry publish, 输入账户密码即可上传项目到 PyPI 仓库.

在这里插入图片描述

登录 pypi 网站 (https://pypi.org/), 你可以在 “Your Projects” 中查看:

在这里插入图片描述

在这里插入图片描述

相关阅读

  • Poetry 官方文档, 写得清晰易懂, 推荐阅读: https://python-poetry.org/docs
  • 其他人写的 Poetry 打包教程: https://learnku.com/python/t/38708
  • 国外有人写的 Poetry 打包教程: https://www.infoworld.com/article/3527850/how-to-manage-python-projects-with-poetry.html
  • 传统的打包发布: https://www.jianshu.com/p/eb7caacf7491
Likianta Me
关注
  • 0
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
docker-python-poetry:预先安装了Poetry的Python docker映像
04-01
docker-python-poetry 一个预先安装了诗歌的基于Debian的python docker容器。 该图像是根据官方的python slim-buster图像构建的。 在上查看图像 根据要查找的python版本，有一些不同的标签。 标签结构是POETRY VERSION，然后是PYTHON VERSION。 因此，如果您想使用Poetry和Python 3.8，则可以使用以下标记之一，具体取决于您希望对诗歌版本1-3.8或1.1-3.8或1.1.4-3.8 请注意，当前只有与最新版本诗歌相对应的标签会更新其基本图片。
micropipenv：用于pip的轻量级包装，以支持requirements.txt，Pipenv和Poetry锁定文件或将其转换为pip-tools兼容的输出。 设计用于容器化的Python应用程序，但不仅限于此
02-05
micropipenv：用于pip的轻量级包装，以支持requirements.txt，Pipenv和Poetry锁定文件或将其转换为pip-tools兼容的输出。 设计用于容器化的Python应用程序，但不仅限于此
Python 常见问题 - 使用 poetry build 打包构建失败，报 ModuleOrPackageNotFound No file/folder found for package
最新发布
YLF123456789000的博客
03-06 447
这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！
Poetry: 让Python依赖项管理和打包变得容易-python
06-18
Python dependency management and packaging made easy. Poetry：Python 的依赖管理 Poetry 帮助您声明、管理和安装 Python 项目的依赖项，确保您在任何地方都有正确的堆栈。 它支持 Python 2.7 和 3.4+。 完整的文档可以在官方网站上找到。 安装 Poetry 提供了一个自定义安装程序，它将通过供应商化其依赖项来安装与系统其余部分隔离的诗歌。 这是安装诗歌的推荐方式。 curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python 或者，您可以下载 get-poetry.py 文件并单独执行。 如果要安装预发布版本，可以通过将 --preview 传递给 get-poetry.py 来实现： python get-poetry.py --preview 同样，如果要安装特定版本，可以使用 --version : python get-poetry.py --ver
Python-Poetry让Python依赖管理和打包变得容易
08-10
可以帮助您声明，管理和安装Python项目的依赖关系，确保您在任何地方都拥有合适的堆栈。
python-poetry-buildpack：Heroku构建包，可以将Poetry与官方Python构建包一起使用
02-18
Python诗歌构建包 适用于用户的 Buildpack。 如何使用 Python Poetry Buildpack通过从poetry.lock生成requirements.txt和runtime.txt来准备要由Python buildpack（例如heroku/python处理的构建。 要通过Heroku CLI设置使用多个buildpack，请使用buildpacks:add ： heroku buildpacks:clear heroku buildpacks:add https://github.com/moneymeets/python-poetry-buildpack.git heroku buildpacks:add heroku/python 配置 Python 可以通过设置PYTHON_RUNTIME_VERSION变量来强制使用Python版本： heroku
强大的包管理器Poetry
既然选择远方，便只顾风雨兼程！
10-16 4132
Poetry 是Python 中用于依赖管理和**打包的工具。**它允许您声明项目所依赖的库，并将为您管理（安装/更新）它们。Poetry 提供了一个锁定文件以确保可重复安装，并且可以构建您的项目以进行分发。作为一个传统虚拟环境的实现，poetry 凭借其强大的依赖分析能力被大量项目所推荐的虚拟环境管理工具。
Python能做大项目(7) - Poetry: 项目管理的诗和远方之二
量化风云
12-26 1053
接下来比较幸运，当 poetry 查找 asyncpg 和 sqlalchemy 的传递依赖时，没有找到它们有更多的传递依赖，解析结束，这样，poetry 就顺利地选择了 29 个版本中，最新的一个，即 SQLAlchemy-1.3.24。另外，如果该依赖发布了一个紧急的安全更新，通常会使用递增修订号的方式来递增版本。当你使用 poetry add 命令，不加任何选项时，该依赖将被添加为发行依赖（在 1.3 以上的 poetry 中，被归为 main 组），即安装你的包的最终用户，他们也将安装该依赖。
Python 常见问题 - 使用 poetry build 打包构建失败，报 ModuleOrPackageNotFound No file/folder found for package...
qq_33801641的博客
10-26 1625
背景 使用 poetry 管理 Python 包的时候 使用 poetry build 来打包工程，报错了 Building filesystemfastapi (0.1.0) ModuleOrPackageNotFound No file/folder found for package filesystemfastapi 工程目录 pyproject.toml 文件 ...
Python 包管理之 poetry
fenglepeng的博客
07-30 1842
poetry是一个Python虚拟环境和依赖管理的工具。poetry和pipenv类似，另外还提供了打包和发布的功能。 官方文档：python-poetry.org/docs/ python项目部署：poetry管理本地环境,上线用docker poetry 安装 poetry提供多种安装方式，个人推荐从以下2种方式中选择： 方式一：（推荐） $ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetr
记录 Poetry 发布包到 pypi 遇到的坑：No suitable keyring backends were found
XavierJ的博客
05-04 850
项目场景 使用 Poetry 开发一个 Python 项目。在本地可以正常使用 poetry build 构建包，然后使用 poetry publish 将包发布到 pypi 官网。但是当我将其部署到 GitHub Actions 时，可以正常构建包，但发布包时却遇到了如下问题。 问题描述 包构建成功了，发布到 pypi 时报错： No suitable keyring backends were found 这是我配置工作流的代码： - name: Publish to PyPI e
copier-poetry：由Poetry管理的Python软件包的复印机模板
02-12
复印诗 诗歌项目的复印机模板。 该复印机模板主要供我自己使用，但请随时尝试或叉它！ 产品特点 设置，带有预定义的pyproject.toml 使用构建的文档（ 和“ autodoc” ） 预先配置的用于代码格式化，质量分析和测试的工具： （ 包装器）和插件， ， 使用和插件运行测试，并提供支持 与跨平台任务 支持GitHub工作流程和Gitlab CI Python 3.6或以上 从git commits自动生成的CHANGELOG.md （使用Angular消息样式） 从Python依赖项自动生成的CREDITS.md 来自所有许可证 为了方便的Makefile 快速设置和使用 确保满足所有，然后： copier " https://github.com/pawamoy/copier-poetry.git " /path/to/your/new/project 甚至
poetry.el：Emacs中的Python依赖关系管理和打包
02-03
poetry.el：Emacs中的Python依赖关系管理和打包
nython：为Nim库构建Python扩展模块
02-03
这是使用Nim的compileToC命令生成的C代码，Python可将该C代码打包为扩展模块，并在其他地方安装您的软件包时进行本地编译。 请注意，这不能解决以下事实：带有C代码的Python轮子是特定于它们构建的平台的。 因此，在...
Python库 | poetry-core-1.0.4.tar.gz
05-20
资源分类：Python库 所属语言：Python 资源全名：poetry-core-1.0.4.tar.gz 资源来源：官方 安装方法：https://lanzao.blog.csdn.net/article/details/101784059
PyPI 官网下载 | poetry-0.9.0.tar.gz
01-14
资源来自pypi官网。 资源全名：poetry-0.9.0.tar.gz
Python 项目管理与构建，这四款工具足够了！
Python学习与数据挖掘
10-12 997
△点击上方“Python猫”关注 ，回复“1”领取电子书作者：隔叶黄莺来源：https://yanbin.blog/python-dependency-management-build-toolsPython 历时这么久以来至今还未有一个事实上标准的项目管理及构建工具，以至于造成 Python 项目的结构与构建方式五花八门。这或许是体现了 Python 的自由意志。不像 Java 在经历了最初的手工构建，到半自动化的 Ant, 再到 Maven 基本就是事实上的标准了。其间 Maven 还接受了其他的 Gr
Poetry的帮助使用指南文档
Hallo_ween的博客
09-26 429
Poetry -q的用法: 静默输出，就是不反馈任何信息 poetry config -h -q。本来是要反馈信息的，但是加上-q后就不会输出任何信息了。Poetry -V的用法: 显示poetry的版本 --ansi设置为有颜色输出。--no-ansi 设置为没有颜色输出。这部分是每个指令都有的。有些可以通过-h查看，还会有更多功能，下面通过简单的例子使用上面的指令演示。本章节会把poetry的所有指令都基本讲一次。会重点介绍项目中常用的指令。或者提交一个 Pull Request。
poetry项目打包工具详细介绍及演示
chengyu950526的博客
07-17 2422
Python虚拟环境和依赖管理工具-poetry 1. poetry 是什么 Poetry 和 Pipenv 类似，是一个 Python 虚拟环境和项目打包工具，比如打包和发布。它可以让你用 Poetry 来同时管理 Python 库和虚拟环境。 主页：https://poetry.eustace.io/ 源码：https://github.com/sdispater/poetry 文档：https://poetry.eustace.io/docs 2. poetry怎么安装 安装poetry的官方命
poetry run python manage.py migrate
06-13
这也是一个命令行指令，用于将 Django 项目中的数据库结构更新至最新版本。在使用时，需要在终端中切换到项目目录，并确保已经安装了 Django 和 poetry 依赖管理工具。执行这个指令后，Django 会检查项目中的迁移文件，并将还未执行的迁移文件应用到数据库中，实现数据库结构的更新。需要注意的是，这个指令只能用于已经生成了迁移文件的项目。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值