Python 让你可以重用代码，并将代码分享给他人以节省时间和精力。所以，当你编写了一些方便的脚本，希望你的同事或其他人也能使用时，接下来该怎么做呢？这篇文章就来解决打包和分发的问题。我们将专注于将你的代码转换为一个 Python 包，以便人们能够轻松安装。

读完这篇文章后，你将能够：

• 了解 Python 包的要求
• 构建一个 Python 包，或者将现有项目转换为一个包
• 使用 pip 安装自己构建的包

一、为什么要构建 Python 包？

想象一下，每次你想解析某种特定格式的文件时，都得从头开始编写代码。你将永远无法完成任何事情！包是编程中的基本构建块。如果没有包，我们将花费大量时间编写已经有人写过的代码。这就是我们总是想要使用包的原因。包是 Python 中层级命名空间概念的体现。

引用《Python 之禅》中的一句话：

“命名空间是个绝妙的主意——让我们多用用！”

如果你想查看完整的《Python 之禅》，可以在 Python 代码单元中输入 `import this`。

这行代码 import this 是一个彩蛋导入语句。在Python中，当你导入this模块时，它会自动打印出"The Zen of Python"（Python之禅），这是由Tim Peters编写的一组Python设计原则和哲学。

即使你从未打算将代码分享给他人，一个结构良好的包也能简化开发过程。

二、构建你自己的 Python 包

现在是时候将你的代码打包了。以下是构建你自己的包需要了解的基本内容。

基本结构：

让我们逐一了解这些文件：

• 包名（例如：calculator）：创建一个与你的包同名的文件夹。在我的例子中，这是一个名为“calculator”的文件夹。这就是我们要安装的包。将你想要发布的文件和类都放入这个文件夹中。包名应尽量简短，全部使用小写字母。除非有助于提高可读性，否则不建议在包名中使用下划线。
• __init__.py：这个文件让 Python 知道我们创建的目录是一个包，文件名没有灵活性。如果你删除了 __init__.py 文件，Python 将不再在该目录中查找子模块，因此尝试导入模块将会失败。__init__.py 文件通常为空，但也可以用于导出包中选定的部分，以便使用更方便的名称，或者包含一些便利函数等。
• tests：每个人都会犯错，这就是为什么铅笔有橡皮擦，电脑有拼写检查，而我们的代码需要测试。我们相信代码能够运行，但必须进行验证。测试文件通常放在一个单独的目录中。
• license：在当今技术世界中，许可证非常常见。有许多不同类型的法律文件可以用来保护你的代码。在创建 Python 包时，有时需要许可证，但无论如何，拥有许可证总是一个好习惯。对于这个示例项目，我使用了MIT 许可证。如果你不确定选择哪种许可证，可以参考 GitHub 提供的选择许可证资源。
• README.md：你的 Python 包应该始终有一个编写良好的 README 文件，因为它不仅展示了项目的质量，还提供了易于阅读和访问的信息。
• setup.py：这个文件告诉 pip 如何安装我们的实际包。它包含对“setuptools”包中的 setup 函数的单一调用。Setuptools 是最常见且功能强大的工具之一。
• name：你的包在 PyPI 上显示的名称。
• version：你的包的当前版本。对于版本号，有许多不同的方案可供选择。对于简单的项目，语义化版本控制 是一个很好的默认选择。例如，我们示例项目的版本号是：0.0.1。
• packages：该参数接受一个包的列表。在我们的例子中，只有一个包：calculator。在较大的项目中，可能会有很多包需要列出。为了简化这个任务，setuptools 提供了一个功能find_packages()，它可以很好地发现你所有的子包。

三、将 Python 包上传到 PyPI

现在你的代码已经打包完成，准备好向全世界展示啦！如果你能坚持到这里，那就给自己点个赞吧，你已经取得了很大的进展，离成功只差一步之遥了！：)。在这一部分，你将看到如何将你的包实际上传到 PyPI。

首先，你需要在 PyPI 上注册一个账号。如果你还没有账号，现在是注册的好时机。你可以在这里注册 PyPI 账号。记得记下你的用户名（注意：不是名字，也不是邮箱地址）和密码，稍后上传过程中会用到。

四、最后步骤

打开存储所有包信息的文件夹的命令提示符。例如：

cd "C://PATH//TO//YOUR//FOLDER"

接下来，我们将使用一个名为 Twine 的工具。你可以通过 pip 安装 Twine：

pip install twine

PyPI 上的包并不是以纯源代码的形式分发的。相反，它们被封装成分发包。最常见的分发包格式是源码归档和 Python wheels。

Python wheels 是什么

Python wheels 是一种预构建的包分发格式，是 Python 包安装和分发的现代标准。

wheels 的主要特点

• 文件格式：.whl 扩展名，本质上是一个 ZIP 压缩文件
• 预编译：包含已编译好的二进制文件，不需要在安装时进行编译
• 快速安装：比传统的源码分发包（sdist）安装速度更快
• 命名规范：遵循 {包名}-{版本}-{构建标签}-{Python标签}-{ABI标签}-{平台标签}.whl 格式

wheels 与 sdist 的比较

• wheels：预构建的二进制分发包，直接安装使用
• sdist：源代码分发包，安装时需要在用户环境中编译

要为你的包创建一个源码归档和一个wheel，我们可以运行以下命令：

python setup.py bdist_wheel

现在，终于到了你期待已久的时刻，再执行最后一个命令：

twine upload dist/*

记得在提示时输入你的用户名和密码，就这样！恭喜你成功上传了第一个 Python 包，访问
https://pypi.org/project/your-package-name/ 查看你的包在 PyPI 上的页面。

五、使用 pip 在 PyPI 上安装你的自定义包

看到自己的代码通过 pip 安装是一种美妙的体验！想试试吗？你可以通过以下命令安装你刚刚上传到 PyPI 的包：

pip install your-python-package

从 GitHub 使用 pip 安装你的自定义包

另外，你也可以直接从 GitHub 使用 pip 安装代码。

创建一个仓库并将所有代码文件推送到该仓库（就像我们之前做的一样）。

复制仓库的 URL，然后通过以下命令安装：

pip install git+https://github.com/username/your-awesome-package.git

这篇文章为你介绍了 Python 包的构建、上传到 PyPI 的原因、过程和方法。

#我的宝藏兴趣#