今天跟大家分享一下如何快速實(shí)現(xiàn)一個(gè)Python CLI應(yīng)用程序的腳手架，之所以會(huì)做這個(gè)是因?yàn)楫?dāng)時(shí)需要做一個(gè)運(yùn)維的小工具希望用命令行的方式來(lái)使用，但是搜遍網(wǎng)上很多資料都沒有系統(tǒng)講解從開發(fā)、集成、發(fā)布、文檔等一系列流程的文章。

工程結(jié)構(gòu)

如上圖，這就是一個(gè)比較規(guī)范的Python CLI應(yīng)用項(xiàng)目了，下面一一講下各文件的用途：

項(xiàng)目文檔

這里我們用Sphinx來(lái)實(shí)現(xiàn)文檔的自動(dòng)生成，當(dāng)然你要首先通過markdown和rst文件定義好文檔的內(nèi)容，然后進(jìn)入docs目錄執(zhí)行 make html命令就可以在_build目錄下生成對(duì)應(yīng)的靜態(tài)文件，如下圖：

具體Sphinx如何使用以及配置后面會(huì)單獨(dú)文章講解

主工程

這里講幾個(gè)需要注意的地方

1、日志的配置：

這里可以全局設(shè)置日志的一些輸出級(jí)別和格式化方式

2、cli文件

這里通過click庫(kù)來(lái)實(shí)現(xiàn)

3、二進(jìn)制文件打包

如上圖，有時(shí)候我們的工程中會(huì)包含二進(jìn)制文件，也就是非Python代碼的文件，這時(shí)候如果還是像往常一樣打包發(fā)布，安裝的時(shí)候會(huì)發(fā)現(xiàn)無(wú)法找到此文件，所以需要在根目錄的MANIFEST.in文件中加入

腳本

如下圖，這里的make-release文件主要是用來(lái)自動(dòng)控制版本的，如下圖，通過Git 的提交記錄了來(lái)作為項(xiàng)目的唯一版本號(hào)標(biāo)識(shí)，再對(duì) init 文件進(jìn)行重新寫入達(dá)到持續(xù)集成時(shí)版本號(hào)自增的目的。

單元測(cè)試

test文件夾中存放的就是項(xiàng)目的單元測(cè)試文件了，這里就不細(xì)展開講了，后面會(huì)具體講講如何跟Jenkins集成實(shí)現(xiàn)靜態(tài)代碼檢查

setup

最重要的就是setup.py這個(gè)文件了，項(xiàng)目最后打包發(fā)布到pypi倉(cāng)庫(kù)主要的配置信息都在這里了，如下圖：

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

總結(jié)

以上是生活随笔為你收集整理的python中的cli模块_Python 快速实现CLI 应用程序的脚手架的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。