手把手教你打包Python库并创建自己的PyPI项目_pypi 增加项目说明

摘要

本文将以py3PortScanner为例，带大家了解如何将已经完成的python package打包，在README中添加travis-ci的__build passing__图标，并将package整体上传至PyPI(Python Package Index)从而使得其他用户可以通过pip命令来直接安装这个package。

背景知识需求

本文需要读者拥有一定的python编程经验和开源软件相关知识，已经了解python package定义并了解如何使用pip进行python库管理。同时需要读者已经对python单元测试以及软件测试有所了解。

创建生成软件包所需的文件

首先，我们需要确保我们的package中已经包含了README.md, LICENSE和setup.py文件。三者分别包含该package的说明文档，许可证和python setuptools所用来安装该package的构建脚本(build script)。

setup.py

setup.py中包含了该package对应的信息(例如该package的名称，版本，作者)以及该package应当包含的程序文件和数据。

参考py3PortScanner的setup.py文件，我们首先读入了README文件和CHANGELOG文件。紧着这我们通过dev_requires关键字指定了开发环境所需要的一些依赖。接着便是最重要的setup()函数。在setup函数中我们指定了该package的作者，版本，描述，描述文件格式，分类，package链接(大多数情况)，package所应当包含的程序文件和数据文件，和程序可以额外安装的运行环境(需要通过python3 -m pip install [.dev_requires]来安装)。同时在此处还应当注意另一个非常重要但在示例中没有用到的关键字：install_requires