Python-封装自己的PyPi包

type

status

date

slug

summary

🔍 准备

首先，我们需要安装两个关键的工具：setuptools和twine。这两个工具是用来创建和发布PyPi包的必备工具。

在命令行中运行以下命令，安装这两个工具：

📓 结构

接下来我们要将自己分享的库按照以下方式组织项目目录结构：

✍️ 代码

包源码

需要封装真正包的源码需要自己填写,这里给出的示例是完成一个yaml文件的解析并输出解析结果。

其他文件

除了源码外的文件也给出示例：

README

LICENSE

可以使用下面这个链接自助选择license

Choose an open source license

Non-judgmental guidance on choosing a license for your open source project

https://choosealicense.com

示例中我们选择了MIT

setup.py

⚒️ 构建

生成带源码文件的.tar.gz的包

生成.whl包

⬆️ 上传

上传至官方PyPi。

官方提供了一个测试仓库和正式仓库，下面给出链接

TestPyPI · The Python Package Index

The Python Package Index (PyPI) is a repository of software for the Python programming language.

https://test.pypi.org/

PyPI · The Python Package Index

The Python Package Index (PyPI) is a repository of software for the Python programming language.

https://pypi.org/

首先在官方PyPi需要拥有账户

上传命令为python3 -m twine upload -r https://test.pypi.org/legacy/ dist/*

上传至私有Artifactory

首先定义私有库url，编辑~/.pypirc

上传命令python3 -m twine upload -r my-artifactory dist/*

📦 安装

安装本地包

当我们开发完成后，可以本地安装进行验证，比如在工程路径下生成了dist/testp-0.1.0-py3-none-any.whl文件后，执行以下命令进行本地安装：

安装远程包

安装官方PyPi或者其他PyPi源的包

📎 参考文章

Packaging Python Projects — Python Packaging User Guide

https://packaging.python.org/en/latest/tutorials/packaging-projects/

Keywords - setuptools 68.0.0.post20230717 documentation

https://setuptools.pypa.io/en/latest/references/keywords.html