首发于公众号:Python编程时光
以上仅介绍了 easy_install 的一些常用的方法,想要了解更多,你可以点击官方文档:
总结一句:setuptools 是官方提供的一个专业用于包分发的工具,若只从安装的角度来看,它的功能确实简单。它更大的意义是对包的分发很有用,定制化程序非常高,我们现在也还在用它进行版本包的发布。
ext_modules
参数用于构建 C 和 C++ 扩展扩展包。其是 Extension 实例的列表,每一个 Extension 实例描述了一个独立的扩展模块,扩展模块可以设置扩展包名,头文件、源文件、链接库及其路径、宏定义和编辑参数等。如:
setup.py 的参数非常多,能够不借助文档写好一个setup.py好像没那么简单。为了备忘,我整理了 setup 函数常用的一些参数:
8. 打包辅助神器PBR 是什么?
pbr
会读取和过滤setup.cfg中的数据,然后将解析后的数据提供给 setup.py
作为参数。包含如下功能:
到此,我讲了三种编写使用 setup.py 的方法
- 使用命令行参数指定,一个一个将参数传递进去(极不推荐)
- 使用 pbr ,在 setup.cfg 中指定(易于管理,更推荐)
使用 sdist 将根据当前平台创建默认格式的存档。在类 Unix 平台上,将创建后缀后为 .tar.gz
的 gzip 压缩的tar文件分发包,而在Windows上为 ZIP 文件。
当然,你也可以通过指定你要的发布包格式来打破这个默认行为
你可以指定的格式有哪些呢?
创建一个压缩的tarball和一个zip文件。可用格式为:
对以上的格式,有几点需要注意一下:
- 在版本3.5中才添加了对
xztar
格式的支持 - zip 格式需要你事先已安装相应的模块:zip程序或zipfile模块(已成为Python的标准库)
- ztar 格式正在弃用,请尽量不要使用
另外,如果您希望归档文件的所有文件归root拥有,可以这样指定
2、构建二进制分发包。
在windows中我们习惯了双击 exe 进行软件的安装,Python 模块的安装也同样支持 打包成 exe 这样的二进制软件包。
而在 Linux 中,大家也习惯了使用 rpm 来安装包,对此你可以使用这条命令实现 rpm 包的构建
若你的项目,需要安装多个平台下,既有 Windows 也有 Linux,按照上面的方法,多种格式我们要执行多次命令,为了方便,你可以一步到位,执行如下这条命令,即可生成多个格式的进制包
正常情况下,我们都是通过以上构建的源码包或者二进制包进行模块的安装。
但在编写 setup.py 的过程中,可能不能一步到位,需要多次调试,这时候如何测试自己写的 setup.py 文件是可用的呢?
这时候你可以使用这条命令,它会将你的模块安装至系统全局环境中
如若你的项目还处于开发阶段,频繁的安装模块,也是一个麻烦事。
这时候你可以使用这条命令安装,该方法不会真正的安装包,而是在系统环境中创建一个软链接指向包实际所在目录。这边在修改包之后不用再安装就能生效,便于调试。
通过上面的学习,你一定已经学会了如何打包自己的项目,若你觉得自己开发的模块非常不错,想要 share 给其他人使用,你可以将其上传到 PyPi (Python Package Index)上,它是 Python 官方维护的第三方包仓库,用于统一存储和管理开发者发布的 Python 包。
如果要发布自己的包,需要先到 pypi 上注册账号。然后创建 ~/.pypirc
文件,此文件中配置 PyPI 访问地址和账号。如的.pypirc文件内容请根据自己的账号来修改。
然后使用这条命令进行信息注册,完成后,你可以在 PyPi 上看到项目信息。
注册完了后,你还要上传源码包,别人才使用下载安装
或者也可以使用 twine
工具注册上传,它是一个专门用于与 pypi 进行交互的工具,详情可以参考官网:,这里不详细讲了。