热线电话：13121318867

登录
首页精彩阅读如何发布一个Python命令行工具
如何发布一个Python命令行工具
2016-03-24
收藏
上次写的一个终端里面斗鱼TV弹幕Python版本和Ruby版本，并且发布到PIP和RubyGems上面.在发布PIP包的时候，居然Google不到一篇可以非常好的讲解这个流程的文章.于是整理这篇文章，并且方便后来自己检索，并且方便他人找资料.

自推荐下依照本文定制的命令行工具danmu.fm的github地址：

https：//github.com/twocucao/danmu.fm

本文的目的也是非常简单：

写一个Python命令行工具，并且发布到PIP上面.并且在这个过程中给出我自己的一些思考.

如何分解这个发布任务？

只需要进行如下的两个步骤便可以：

1.写好一个Python命令行工具.

2.发布它.

当然,这样不够细致.再细分一下.


1.写好一个Python命令行工具

写好一个命令行工具首先要知道命令行工具是什么？

在我看来，命令行工具就是一种完成某种类型的任务的终端程序.

也就是基本上没有什么用户界面的程序.

由于基本上没有什么用户界面，所以导致单个命令行的交互能力及其低下.但这种低下的交互性对于一些固定工作而言，简直就是最灵活的工具.只需要输入一些命令便可以完成某种类型的工作.实在是方便的很.

所以，某种程度上，终端程序低交互的缺点反而成了优点.

1.1.Python的如何编写一个简单的命令行

对于Python和命令行交互，我们很容易想出一个比较方便的方案.

sys.argv就是这样的嘛！

我们很容易这样写代码.



甚至我们也可以这样写命令行，



那么，这样写的后果就是，不方便解析出(不是不能，是不方便) -d -f 0 以及 thisisaargv1.

不信的话，你解析一个下面场景的命令行试试，


于是Python就提供了一个非常好用的模块可以使用.叫做argparse.

上面的描述就变成了这个样子


保存为danmu.py

这样就可以执行命令



python danmu.py http：//www.douyutv.com/xiaocang -q 1 -v 2

通过args就可以获取参数，然后进行终端程序的参数初始化.

可是这和我们的要求还是不同嘛，我们不想多写Python XXX，我们想直接XXX.就像这样.



不急，下面就是了.

1.2.如何组织代码结构.

于是，现在就要开始组织代码结构了.

我们在最终的代码目录大概是这样的.



这就是我上次写的danmu.fm的代码目录.

聪明的你这时候你注意到了：

1.主要的程序不是放在根目录下面，而是放在第二目录danmufm下面.

2.setup.cfg 是什么鬼东西

3.setup.py 是什么鬼东西

对于上面几点，我们分别进行解释

1.2.1 为什么主要程序在第二目录下

为了把主要的程序分离出来，放在第二目录下面，这样的待会打包以后多出很多文件夹就不会对源码造成干扰.

当然，由于把程序放在了第二目录下面，所以，脚本里面的from import语句应该使用相对路径导入.

相对路径导入的的时候需要注意运行的时候使用如下命令



1.2.2 setup.cfg

填写如下内容即可.


然后去写Markdown的Readme就好了.

1.2.3 setup.py

这个是重头戏了.

setup这个py文件就是打包配置文件.对这个程序是谁的，有什么依赖，入口是什么，等等等等的配置.



官方有distutils这个包管理器工具，设置也非常的简单，只是，它不支持entry_points属性，由于无法使用entry_point，也就无法通过命令来跳转到指定模块运行程序，这也就意味着，官方工具不方便写成命令行.还是setuptools好.

上面需要注意的就是install_requires可以添加依赖.其他的你猜都可以猜出来是做什么的.自己去看代码，我就不多说了.

2. 发 布

所谓的发布，就是将打包好的程序的某个版本发布到某个仓库中.

2.1.注册pypi账户

到这个上面注册账号：

https：//pypi.python.org/pypi

2.2.注册在账户下面注册Python包

进入对应项目根文件，然后执行



这一步程序会让你输入刚刚注册的账号和密码，然后注册该包.注册该包以后，你就有了一个小仓库.可以存放不同版本的danmu.fm.

注册的仓库是可以在这个地址看到的，

https：//pypi.python.org/pypi？%3Aaction=pkg_edit&name=danmu.fm

2.3.上传打包好的Python命令行工具.

这里需要借助一个小工具，twine.twine是一个更加安全方便上传打包好的代码的工具.



接着开始打包，打包成两个版本，一个是不需要build的版本，另一个是需要build的版本(顺带吐槽下，这两个诡异的命名).



于是剩下来的就显而易见了，上传build完毕的程序到仓库中.


于是，安装一下，测试是否成功


命令行的工具是这样使用的.



3. 完 善

不断的完善代码，然后打包终端程序发布到仓库给别人用，这就是整个的PIP打包发布流程.

1.这个时候，你可能需要使用版本控制软件.

2.你可能需要增多的代码的测试.

文 | 无与童比

来源 | 简书




CDA数据分析师考试相关入口一览（建议收藏）：

▷ 想报名CDA认证考试，点击>>>   “CDA报名” 了解CDA考试详情；

▷ 想加入CDA考试题库，点击>>> “CDA题库” 了解CDA考试详情；

▷ 想学习CDA考试教材，点击>>> “CDA教材” 了解CDA考试详情；

▷ 想查询CDA考试成绩，点击>>> “CDA成绩” 了解CDA考试详情；

▷ 想了解CDA考试含金量，点击>>> “CDA含金量” 了解CDA考试详情；

▷ 想获取CDA考试时间/费用/条件/大纲/通过率，点击 >>>“CDA考试官网” 了解CDA考试详情；

python

数据分析咨询请扫描二维码

上一篇图论在大数据分析中的作用！
下一篇CDA认证再升一档！与国家共同推进大数据人才培养标准教育事业！
CDA考试动态
CDA报考指南
热门栏目
最新资讯
更多
Copyright © 2015-present 北京国富如荷网络科技有限公司 All Rights Reserved.
京ICP备11001960号-9   京公网安备 11010802034615号   经营许可证编号：京B2-20210330
客服在线
立即咨询