本文主要介绍如何对模块进行打包,生产.whl文件,直接可以通过pip install *.whl进行安装,另外,还可以将打好的包上传到官方仓库 PyPI中。
Wheel和Egg都是python的打包格式,根据官网说明,Wheel是发行版Python的新标准并且将要取代.egg,Wheel现在是Python的二进制包的标准格式。
Wheel安装pip install wheel
模块目录结构说明
setup.py :打包配置文件setup.cfg:包含了构建时候的一些默认参数,无可不添加该文件.MANIFEST.in:额外需要打包的文件,无可不添加该文件.README.md:项目说明文档LICENSE.txt:项目许可说明文件,无可不添加该文件.项目源码:模块源码目录
setup.cfg文件,如下。
MANIFEST.in文件,如下
setup.py 示例说明
主要配置内容:
name:项目名称,也是最终在 PyPI 上搜索的名称。version:版本号,一般由“主版本号、子版本号、修正版本号”三部分组成。author:作者姓名。description:项目的简短描述,一般一句话就好,会显示在 PyPI 上名字下端。url:通常为项目的GitHub、文档等链接packages:列出项目内需要被打包的所有package。package_data:依赖数据文件,数据文件须放在项目目录内且使用相对路径。data_files:如果数据文件不存在于项目目录内,则使用 data_files 参数或者 MANIFEST.in 文件进行管理。install_requires – 说明项目的依赖包,安装包时pip会自动安装。
示例如下:
生成whl文件
使用 bdist_wheel 打包
python setup.py bdist_wheel
执行完成后,目录结构如下:
安装部署
大家将打包好的.whl对外发布,使用者可以通过pip进行安装部署。
pip install *.whl若对您有所帮助,欢迎大家评论、留言。