随着Python越来越火热,各种Python包层出不穷,一句pip命令就能获得十分强大的功能。作为技术咖的你是否也曾想过制作一个可以用pip安装的Python包,分享自己的技术呢?那就让我手把手来带你做一个吧!
1
面向的读者:
· 掌握了git的使用方法,可以管理代码仓库,并能够上传到github。
· 有Python的基本知识,使用过pip安装Python包。
· 不知道如何制作一个可以用pip安装的Python包。
本文的样例工程:
https://github.com/1049451037/qrcode_song
2
代码结构:
main_folder/# 主文件夹
····package_name/# 核心功能文件夹
········__init__.py# 声明这是一个包
········code.py# 核心代码
····setup.py# 安装配置文件
····README.md# 说明文件
····LICENSE# 版权许可证
3
俗话说:“麻雀虽小,五脏俱全。”上面的结构基本上是一个Python包的最低配置了。下面对每一部分进行说明。
setup.py:内容比较固定,就是对自己的包进行说明
code.py:放一些自己写的函数
__init__.py:在这里只需要写进一句from .code import *即可
README.md:一个说明文档
LICENSE:一般使用MIT证书,基本上就是一个txt文件,格式固定
4
安装方法:
有了上面的代码,我们就可以来安装了。不管是在Windows还是在Linux,在终端里cd到项目所在目录,然后运行:
pip install .
如果想安装给所有用户:
pip install -e .
安装完成!
5
以上方法只适用于源码安装,把代码发布到Github,其他用户也可以下载到本地,使用同样的方式安装。
如果想通过pip install package_name的方式,请学习PyPI发布的相关知识~
领取专属 10元无门槛券
私享最新 技术干货