有过一定的 Python 经验的开发者都知道,当引入第三方包时,我们常常会使用 pip install 命令来下载并导入包。
那么,如何写一个自己的包,上传到 PyPI 呢,其他开发者也可以通过 pip install 命令下载并导入?
本文提供了最简单的示例。
准备好项目目录
创建一个项目目录,其目录结构如下:
/packaging_tutorial
/example_pkg
__init__.py
其中,packaging_tutorial 是一个文件目录,example_pkg 是一个你希望上传的 Python 包。
注:本人使用的是 virtualenv + virtualenvwrapper 构建的 Python 虚拟环境,因此 python 和 pip 命令(而非 python3 和 pip3)直接对应的是我所指定的虚拟环境(Python 3.6.7)。
创建一些必要文件
再向 packaging_tutorial 中创建一些文件。其目录结构如下:
/packaging_tutorial
/example_pkg
__init__.py
setup.py
LICENSE
README.md
创建 README.md 文件
在 README.md 可以输入一些介绍项目的文档。
# 测试
这只是一个测试。
- 测试 1
- 测试 2
- 测试 3
创建 setup.py 文件
setup.py 是 setuptools 的构建脚本,