如何发布你自己的脚本

如何发布你自己的脚本

💡 原文中文,约1400字,阅读约需4分钟。
📝

内容提要

本文介绍了如何创建、打包和发布Python程序到PyPI,包括项目目录结构、代码和元数据文件的编写,使用setuptools配置setup.py和pyproject.toml,打包和本地安装,最后通过twine上传到PyPI。

🎯

关键要点

  • 创建项目目录结构mypkg_project,包括mypkg文件夹和相关文件。
  • 在mypkg/utils.py中编写add函数,mypkg/__init__.py中导入该函数。
  • 在README.md中添加包的描述信息。
  • 在setup.py中配置包的元数据,包括名称、版本、作者等信息。
  • 在pyproject.toml中指定构建系统的依赖和后端。
  • 使用命令python3 -m build打包项目,生成.whl和.tar.gz文件。
  • 通过pip安装本地生成的包,验证功能是否正常。
  • 安装twine工具以便上传包到PyPI。
  • 使用twine upload命令将包上传到PyPI,需提供用户名和token。
  • 上传成功后,用户可以通过pip安装发布的包。

延伸问答

如何创建一个Python包的项目结构?

创建一个目录mypkg_project,包含mypkg文件夹和相关文件,如__init__.py、utils.py、README.md、setup.py和pyproject.toml。

在setup.py中需要配置哪些元数据?

在setup.py中需要配置包的名称、版本、作者、描述、长描述、包的分类和Python版本要求等信息。

如何打包和本地安装Python包?

使用命令python3 -m build打包项目,生成.whl和.tar.gz文件,然后使用pip安装本地生成的包。

如何将Python包上传到PyPI?

首先安装twine,然后使用命令twine upload dist/*,并提供PyPI的用户名和token进行上传。

在README.md中应该包含哪些内容?

README.md中应包含包的描述信息,例如包的名称和功能简介。

如何验证本地安装的Python包功能是否正常?

可以通过在Python中导入包并调用其函数来验证功能,例如使用from mypkg import add和add(2, 3)。

➡️

继续阅读