Github的Python项目发布到PyPI的简单方法札记

博主： huoyu
发布时间：2025 年 01 月 07 日
24 次浏览
暂无评论
1209字数
分类：技术教程

Loading...

最近在弄一个新的Python项目，想把它放在PyPI上。由于之前的项目要么需要手动在本地通过`build`和`twine`打包上传，要么就是推上到Github仓库后，再各种设置Github Action以实现自动打包上传，虽然简单了不少，但还是需要自己生成token，并将其设置在仓库的secrets里面，步骤还是有点点多。现在PyPI支持了所谓的[“受信任发布者”（Trusted Publisher）](https://docs.pypi.org/trusted-publishers/)，让发布流程更加的方便了。本文将以自己的新项目[ihook](https://github.com/JezaChen/ihook/)作为例子，简单介绍下如何快速将自己在Github上的Python项目发布到PyPI上。

## 步骤

1. 不必多说，需要发布到PyPI的Python项目需要有一个构建文件（比如使用`setuptools`构建的话，就需要`setup.py`或者`setup.cfg`）。具体可以参考PyPa的[官方文档](https://packaging.python.org/tutorials/packaging-projects/)。我自己小项目的`setup.py`大差不差，可以参考[这里](https://github.com/JezaChen/ihook/blob/main/setup.py)。
2. 注册一个PyPI账号。直接去[PyPI](https://pypi.org/)注册就好。
3. 将自己的项目推到Github的一个仓库上。
4. 新建一个workflow（仓库网页->Actions->New workflow），选择“Publish Python Package”，此时Github会生成一个workflow文件（类似[这样](https://github.com/JezaChen/ihook/blob/main/.github/workflows/python-publish.yml)），**无需任何改动，直接commit**即可。
5. 进去PyPI账号设置页里面的“Publishing”选项卡（可以直接点击[这里](https://pypi.org/manage/account/publishing/)），在下方的Github选项卡里面输入项目名字、账号名、仓库名以及workflow文件的路径（一般是`python-publish.yml`），然后点击“Add”即可。

![image.png](http://type.zimopy.com/usr/uploads/2025/01/2394359773.png)

此时，只需在Github仓库创建Release，即可自动触发workflow，将项目发布到PyPI上！

最后修改：2025 年 01 月 07 日

© 允许规范转载

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱

地址

huoyu1
真的很需要
欣
很牛逼|´・ω・)ノ
hhh
真棒
Hongjia
https://blog.dingtone.me/zh/rec...
Hongjia
https://5sim.net/zh使用该网站可以最低1 卢布充值

Github的Python项目发布到PyPI的简单方法札记

huoyu • 2025 年 01 月 07 日

Loading...

最近在弄一个新的Python项目，想把它放在PyPI上。由于之前的项目要么需要手动在本地通过`build`和`twine`打包上传，要么就是推上到Github仓库后，再各种设置Github Action以实现自动打包上传，虽然简单了不少，但还是需要自己生成token，并将其设置在仓库的secrets里面，步骤还是有点点多。现在PyPI支持了所谓的[“受信任发布者”（Trusted Publisher）](https://docs.pypi.org/trusted-publishers/)，让发布流程更加的方便了。本文将以自己的新项目[ihook](https://github.com/JezaChen/ihook/)作为例子，简单介绍下如何快速将自己在Github上的Python项目发布到PyPI上。

## 步骤

1. 不必多说，需要发布到PyPI的Python项目需要有一个构建文件（比如使用`setuptools`构建的话，就需要`setup.py`或者`setup.cfg`）。具体可以参考PyPa的[官方文档](https://packaging.python.org/tutorials/packaging-projects/)。我自己小项目的`setup.py`大差不差，可以参考[这里](https://github.com/JezaChen/ihook/blob/main/setup.py)。
2. 注册一个PyPI账号。直接去[PyPI](https://pypi.org/)注册就好。
3. 将自己的项目推到Github的一个仓库上。
4. 新建一个workflow（仓库网页->Actions->New workflow），选择“Publish Python Package”，此时Github会生成一个workflow文件（类似[这样](https://github.com/JezaChen/ihook/blob/main/.github/workflows/python-publish.yml)），**无需任何改动，直接commit**即可。
5. 进去PyPI账号设置页里面的“Publishing”选项卡（可以直接点击[这里](https://pypi.org/manage/account/publishing/)），在下方的Github选项卡里面输入项目名字、账号名、仓库名以及workflow文件的路径（一般是`python-publish.yml`），然后点击“Add”即可。

![image.png](http://type.zimopy.com/usr/uploads/2025/01/2394359773.png)

此时，只需在Github仓库创建Release，即可自动触发workflow，将项目发布到PyPI上！