原文地址:https://www.stephenw.cc/post/SpPIvHpHl6
難度:??
需求背景:在日常移動端的開發(fā)過程中,CI是很重要的東西,尤其當模塊化完成后雾袱,所有模塊都需要從CI發(fā)布集成七婴,不停地打開網(wǎng)頁是一件很低效的事情,所以用命令行工具的想法應運而生彩郊。
準備工作:python 2.7.x前弯, virtualenv
首先建立項目目錄結構,項目起名叫swagdog
:
├── README.md
├── swagdogsrc
│ ├── __init__.py
│ └── swagdog.py
├── setup.cfg
├── setup.py
└── venv
其中主要代碼將寫在 swagdogsrc/swagdog.py
中
解析命令行參數(shù)
python 2.7 以上提供了 argparse
包用于解析參數(shù)和提供命令選項焦辅,具體使用如下:
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
函數(shù)中博杖,第一個參數(shù)的意思是指令的alias,第二個是指全名筷登,同時也是解析后args
參數(shù)字典中的 key剃根。help字段不多做解釋了,最后一個 action參數(shù)是可選的前方,使用 action表示使用這個指令時可以不添加參數(shù)狈醉。假如 action參數(shù)沒有定義,那么解析出來的 args
字典中對應的字段就是 None
惠险。
在拿到對應的參數(shù)后我們便可以執(zhí)行指定的工作了
數(shù)據(jù)存儲
有時我們需要命令行工具存取一些簡單的用戶信息苗傅,方便以后快速操作。在現(xiàn)有的讀寫權限下班巩,我們可以選取用戶目錄~
作為數(shù)據(jù)存儲的目錄渣慕。
config_dir = os.path.expanduser('~') + '/.swagdog/'
config_file = config_dir + 'swagdog.yaml'
這里我沒有用 SQLite等存取方式,使用了 yaml文件抱慌,易于從字典數(shù)組等數(shù)據(jù)類型相互轉(zhuǎn)化逊桦。python中也有非常好用的解析 yaml文件的包 pyyaml
.
本地安裝測試
在開發(fā)過程中我們可以直接 python swagdogsrc/swagdog.py
來調(diào)試,但需要發(fā)布的時候抑进,建議先本地安裝一次試試看强经,我們需要編寫 setup.cfg
和 setup.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'
這一行在指定命令行的命令名稱調(diào)用的具體函數(shù)寺渗,我定義為源代碼中的 entry
函數(shù)匿情,所以源代碼需要一層函數(shù)封裝。
然后信殊,直接執(zhí)行 python setup.py
即可本地安裝測試
發(fā)布到pypi
為了讓別人也能用炬称,需要發(fā)布到 pypi上去。首先需要到 https://pypi.python.org/注冊一個賬戶涡拘,然后執(zhí)行:
python setup.py register
輸入你注冊的賬戶和密碼转砖,你就會擁有存儲這個工具的空間了,然后把工具上傳上去:
pip install twine
python setup.py sdist bdist_wheel
twine upload dist/swagdog-0.1*
上傳完成后就可以使用 pip install swagdog
來安裝了。
完善
- 你可能需要測試更多版本的 python支持
- 注意最python版本的限制府蔗,不同環(huán)境的安裝引導
- macOS 原生的python不支持眾多特性晋控,建議
brew install python
替換
- EOF -