Python包发布

参考

• distributing doc (opens new window)
• 官方示例 (opens new window)

‍

概述

Python包的发布大致分为两个主要过程：打包和发布。

打包

1. 项目结构: 首先，确保项目有一个合适的目录结构。通常，一个 Python 项目应该包含一个顶级目录，其中包含了你的代码文件和其他必要文件，例如 README、LICENSE、setup.py 等。一个常见的目录结构如下所示：

   mypackage/
   ├── mymodule.py
   ├── README.md
   ├── LICENSE
   └── setup.py
   

2. 创建 setup.py: 创建一个 setup.py​​ 文件用于描述你的包的元数据。

   在 setup.py​ 中可以指定包的名称、版本、作者、许可证信息等。具体内容可以参考 Python 官方文档中的示例 (opens new window)。

3. 构建分发包: 使用 setuptools​​​ 或其他打包工具，运行以下命令来创建分发包：

   python setup.py sdist bdist_wheel
   

   这将在 dist​​ 目录中生成一个 .tar.gz​​ 文件和一个 .whl​​ 文件，前者是源码压缩包，后者是常见的whl安装文件。

‍

发布

完成打包动作之后可以选择将包发布到 PyPI，或者将包上传到其他位置供其他人使用。

学习时建议使用https://test.pypi.org​

1. PyPI 帐户: 确保在 PyPI 上有一个帐户。

2. 上传到 PyPI:

   • 使用 twine​​​ 工具上传包。确保已经安装了 twine​​​，然后运行以下命令：

     如果不是用pypi则还需要指定--repository-url https://test.pypi.org/legacy/​​

     twine upload dist/*
     

   • ​twine​​​ 会提示你输入 PyPI 帐户的用户名和密码，然后上传你的包。

     建议到pypi的账号设置中获取token，使用token做验证。

3. 验证和发布: 一旦上传完成并一切正常，它将被发布到 PyPI，供其他人使用。