[Python]编写和发布一个Python CLI工具

原文地址:https://www.stephenw.cc/post/SpPIvHpHl6
难度:⭐️
需求背景:在日常移动端的开发过程中,CI是很重要的东西,尤其当模块化完成后,所有模块都需要从CI发布集成,不停地打开网页是一件很低效的事情,所以用命令行工具的想法应运而生。
准备工作:python 2.7.x, virtualenv

首先建立项目目录结构,项目起名叫swagdog

├── README.md  
├── swagdogsrc
│   ├── __init__.py  
│   └── swagdog.py
├── setup.cfg
├── setup.py
└── venv

其中主要代码将写在 swagdogsrc/swagdog.py

解析命令行参数

python 2.7 以上提供了 argparse
包用于解析参数和提供命令选项,具体使用如下:

parser = argparse.ArgumentParser()
parser.add_argument('-i', '--init', help="初始化命令行工具", action="store_true")
parser.add_argument('-a', '--add', help="添加新的 task", action="store_true")
parser.add_argument('-d', '--delete', help="删除指定名称的 task")
args = parser.parse_args()

add_argument函数中,第一个参数的意思是指令的alias,第二个是指全名,同时也是解析后args参数字典中的 key。help字段不多做解释了,最后一个 action参数是可选的,使用 action表示使用这个指令时可以不添加参数。假如 action参数没有定义,那么解析出来的 args字典中对应的字段就是 None

在拿到对应的参数后我们便可以执行指定的工作了

数据存储

有时我们需要命令行工具存取一些简单的用户信息,方便以后快速操作。在现有的读写权限下,我们可以选取用户目录~作为数据存储的目录。

config_dir = os.path.expanduser('~') + '/.swagdog/'
config_file = config_dir + 'swagdog.yaml'

这里我没有用 SQLite等存取方式,使用了 yaml文件,易于从字典数组等数据类型相互转化。python中也有非常好用的解析 yaml文件的包 pyyaml.

本地安装测试

在开发过程中我们可以直接 python swagdogsrc/swagdog.py来调试,但需要发布的时候,建议先本地安装一次试试看,我们需要编写 setup.cfgsetup.py来配置。
setup.cfg比较简单

[metadata]
description-file = README.md

setup.py相对复杂一点:

from setuptools import setup, find_packages

VERSION = '0.1'

setup(name='swagdog',
      version=VERSION,
      description='swagdog cli tool',
      long_description='swagdog cli tool',
      classifiers=[],
      keywords='swagdog',
      author='stephenw',
      author_email='admin@stephenw.cc',
      url='https://github.com/xxx',
      license='MIT',
      packages=find_packages(),
      include_package_data=True,
      zip_safe=True,
      install_requires=[
          'PyYAML'
      ],
      entry_points={
          'console_scripts': [
              'swagdog = swagdogsrc.swagdog:entry'
          ]
      })

补充一下:'swagdog = swagdogsrc.swagdog:entry'这一行在指定命令行的命令名称调用的具体函数,我定义为源代码中的 entry函数,所以源代码需要一层函数封装。
然后,直接执行 python setup.py即可本地安装测试

发布到pypi

为了让别人也能用,需要发布到 pypi上去。首先需要到 https://pypi.python.org/注册一个账户,然后执行:

python setup.py register  

输入你注册的账户和密码,你就会拥有存储这个工具的空间了,然后把工具上传上去:

  pip install twine  
  python setup.py sdist bdist_wheel  
  twine upload dist/swagdog-0.1*  

上传完成后就可以使用 pip install swagdog来安装了。

完善

  • 你可能需要测试更多版本的 python支持
  • 注意最python版本的限制,不同环境的安装引导
  • macOS 原生的python不支持众多特性,建议 brew install python 替换

- EOF -

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,738评论 5 472
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,377评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,774评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,032评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,015评论 5 361
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,239评论 1 278
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,724评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,374评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,508评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,410评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,457评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,132评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,733评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,804评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,022评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,515评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,116评论 2 341

推荐阅读更多精彩内容