[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='[email protected]',
      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 -

你可能感兴趣的:([Python]编写和发布一个Python CLI工具)