PyPI打包实践教程-2019

本教程将指导您如何打包一个简单的Python项目。它将从0开始向您展示如何添加必要的文件和结构来创建包，如何构建包以及如何将其上传到PyPI供他人使用。

子曰：知之为不知，不知为不知，太菜也！

要点说明：

1. 本文从最基础的创建文件开始，如果不需，请跳至上传并发布包文件到PyPI
2. 为了防止包冲突，可采用conda的虚拟环境来搭建环境
3. 更多细节参看官网(会有坑)

项目框架

---

本教程使用一个名为的example_pkg简单项目。即使您已经有一个要打包的项目，我们仍然建议您按照本示例包使用此示例包，然后尝试使用自己的包。

TIPS:MANIFEST.in 文件用来表示忽略的文件目录，此处知道便可。

要在本地创建此项目，请创建以下文件结构：

packaging_tutorial/
  example_pkg/
    __init__.py

创建此结构后，您将需要在顶级文件夹中运行本教程中的所有命令 - 所以需要cd packaging_tutorial

您还应该编辑example_pkg/__init__.py并在其中放入以下代码：

name = "example_pkg"

这只是为了让您可以在本教程后面验证它是否正确安装，并且PyPI不会使用它。

添加文件

---

添加前须知

• 假设你的包已经开发完成，并且根目录必须要有一个setup.py。
• 最好有一个 README.md用来描述你的包，虽然这不是必须的，但文档性说明，你最好还是要有的。
• 如果你需要打包代码文件夹以外的文件，比如版权信息等等，你还需要写一个 LICENSE。

您现在将创建一些文件。创建下面列出的新文件，下面会详细介绍每个文件的内容。

packaging_tutorial/
  example_pkg/
    __init__.py
  setup.py
  LICENSE
  README.md

创建的setup.py

setup.py是