一文读懂:从 Python 打包到 CLI 工具_python编译为cil

install_requires = [“requests”]


当然 setup 还有很多可以选择的项可以填,你可以 python setup.py –help 查看,也可以去看 文档


OK,看一下现在目录的结构:


![一文读懂:从 Python 打包到 CLI 工具](http://p1.pstatp.com/large/pgc-image/1bbe85893273450e98ffe26e1e34cacc)


 


这里面还需要说一下,setup 文件支持用配置文件来编写里面的参数


![一文读懂:从 Python 打包到 CLI 工具](http://p3.pstatp.com/large/pgc-image/b728f8361730425498fcd19f8c024792)


 


更多的帮助信息你可以查看 这篇文档


## 打包


打包这一步我认为比较简单,目前比较流行的2中打包的方式:



$ python setup.py bdist_egg # 生成类似 edssdk-0.0.1-py2.7.egg,支持 easy_install
$ python setup.py sdist # 生成类似 edssdk-0.0.1.tar.gz,支持 pip


上面两条命令都会将文件生成到 dist 目录中


当然还有其他非主流格式或者其他选项,可以通过下面这个命令查看:



$ python setup.py --help-commands


## 注册PyPI包


我是直接在 SSH 下面进行操作的,你也可以通过 网页 来做,SSH 步骤:


![一文读懂:从 Python 打包到 CLI 工具](http://p9.pstatp.com/large/pgc-image/27f6368089ef4846974254c92ac0c4e2)


 


关于 register 更详细的内容可以看 PackageIndex


## 上传到PyPI


上传文件也是有 SSH 和 网页两种方法。


网页: 在浏览器登陆到 PyPI 点击 Your packages 中 Egg 的项目,然后选择某个版本的 files 即可看到上传界面。


* 下面这句话还是比较常用的,因为你的包以后更新的话,就不用再去注册了,直接使用下面的命令生成包并上传即可。


SSH:



$ python setup.py sdist upload


这个又是一堆的输出信息,我就不罗列了。


## 安装测试


用 pip 安装:


![一文读懂:从 Python 打包到 CLI 工具](http://p99.pstatp.com/large/pgc-image/b8df3bf78a374f27af7cebd63eef5bb2)


 


测试:


![一文读懂:从 Python 打包到 CLI 工具](http://p3.pstatp.com/large/pgc-image/84bca773737f40c689091519312eef26)


 


OK, 现在这个 sdk 大家都可以用到了~~~~~


关于 upload 更详细的内容可以看 Uploading




---


**setup.py 中调用当前目录的文件一定要加 MANIFEST.in 并将调用文件 include 进来**


使用 python setup.py sdist 打包时,如果 setup.py 调用了当前目录中的文件(如README.rst):



$ long_description = open(‘README.rst’).read()


一定要在增加 MANIFEST.in 文件并将调用文件 include 进来,否则将导致用户在 pip install 时报文件找不到的错误,示例:



$ cat MANIFEST.in
include README.rst


更详情的可以看 docs.python.org


项目逻辑内容如果直接在 '**init**.py' 中完成的话,那么引用就可以更简便了。




---


**CLI命令行工具介绍**


CLI(command-line interface,命令行界面)是指可在用户提示符下键入可执行指令的界面,它通常不支持鼠标,用户通过键盘输入指令,计算机接收到指令后,予以执行。


就我直观的理解就是,这就是给程序员使用的,可以在终端即使装XX的美妙工具。


## CLI制作


由于是 CLI 的命令行工具,所以程序一定要有一个入口的位置,所以我在 help.py 里面添加了 main 函数:


![一文读懂:从 Python 打包到 CLI 工具](http://p3.pstatp.com/large/pgc-image/ee403253a68c483fbaca0b3d226076a6)


 


这个 main 下面会在 setup.py 中用到,下面说一下 setup.py 的相关修改。



> 
>  看英文文档真的是头大,所以后来干脆到 github 上面去找 CLI 的源码来看。发现每个 CLI 工具的 setup.py 中都会有 entry\_points 这个节点。 
> 


![一文读懂:从 Python 打包到 CLI 工具](http://p3.pstatp.com/large/pgc-image/35f6e5a3b5634f428a61cc0e434eb828)


 


完整的 setup.py 为:


![一文读懂:从 Python 打包到 CLI 工具](http://p3.pstatp.com/large/pgc-image/dd52eb3f146c4eedbe85c29043f93b0d)


 


这个里面多了一个 entry*points 节点,里面的 console*scripts 指明了命令行工具的名称:



edssdk = edssdk.help:main


等号前面指明了工具包的名称,等号后面的内容指明了程序的入口地址,当然,这个可以有多条记录,这样一个项目就可以制作多个命令行工具了


## 制作PyPI


制作包的过程和上面的是一样的


![外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传](https://img-home.csdnimg.cn/images/20230724024159.png?origin_url=http%3A%2F%2Fp3.pstatp.com%2Flarge%2Fpgc-image%2F6cf39155f38e46c78d40ac38d0c207fa&pos_id=img-K9slrOYz-1714231717113)


 


**安装测试**


通过 pip 更新一下包:


测试工具包:


![外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传](https://img-home.csdnimg.cn/images/20230724024159.png?origin_url=http%3A%2F%2Fp1.pstatp.com%2Flarge%2Fpgc-image%2F6499e7031953479b9ef2fd0d8d4f829c&pos_id=img-00VZi7mN-1714231717114)


 


OK,方法已经找到了,CLI 工具也就好弄了。




---


**这里讲解一下 Setup.py 中的一些参数**


* packages 告诉Distutils需要处理那些包(包含 \_\_init\_\_.py的文件夹)
* package\_dir 告诉Distutils哪些目录下的文件被映射到哪个源码包,感觉好像是一个相对路径的定义。一个例子: package\_dir = {'': 'lib'},表示以lib为主目录。
* ext\_modules 是一个包含Extension实例的列表,Extension的定义也有一些参数。
* ext\_package 定义extension的相对路径
* requires 定义依赖哪些模块
* provides 定义可以为哪些模块提供依赖
* scripts 指定python源码文件,可以从命令行执行。在安装时指定–install-script
* package\_data 通常包含与包实现相关的一些数据文件或类似于readme的文件。


package*data = {'': ['*.txt'], 'mypkg': ['data/\_.dat'],}



**(1)Python所有方向的学习路线(新版)**  

这是我花了几天的时间去把Python所有方向的技术点做的整理,形成各个领域的知识点汇总,它的用处就在于,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。

最近我才对这些路线做了一下新的更新,知识体系更全面了。



![在这里插入图片描述](https://img-blog.csdnimg.cn/1f807758e039481fa866130abf71d796.png#pic_center)



**(2)Python学习视频**



包含了Python入门、爬虫、数据分析和web开发的学习视频,总共100多个,虽然没有那么全面,但是对于入门来说是没问题的,学完这些之后,你可以按照我上面的学习路线去网上找其他的知识资源进行进阶。

![在这里插入图片描述](https://img-blog.csdnimg.cn/d66e3ad5592f4cdcb197de0dc0438ec5.png#pic_center)



**(3)100多个练手项目**

我们在看视频学习的时候,不能光动眼动脑不动手,比较科学的学习方法是在理解之后运用它们,这时候练手项目就很适合了,只是里面的项目比较多,水平也是参差不齐,大家可以挑自己能做的项目去练练。

![在这里插入图片描述](https://img-blog.csdnimg.cn/f5aeb4050ab547cf90b1a028d1aacb1d.png#pic_center)




**网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**

**[需要这份系统化学习资料的朋友,可以戳这里无偿获取](https://bbs.csdn.net/topics/618317507)**

**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**
g.cn/f5aeb4050ab547cf90b1a028d1aacb1d.png#pic_center)




**网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**

**[需要这份系统化学习资料的朋友,可以戳这里无偿获取](https://bbs.csdn.net/topics/618317507)**

**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值