Python 快速实现CLI 应用程序的脚手架
今天跟大家分享一下如何快速实现一个Python CLI应用程序的脚手架，之所以会做这个是因为当时需要做一个运维的小工具希望用命令行的方式来使用，但是搜遍网上很多资料都没有系统讲解从开发、集成、发布、文档等一系列流程的文章。
工程结构
如上图，这就是一个比较规范的Python CLI应用项目了，下面一一讲下各文件的用途：
项目文档
这里我们用Sphinx来实现文档的自动生成，当然你要首先通过markdown和rst文件定义好文档的内容，然后进入docs目录执行 make html命令就可以在_build目录下生成对应的静态文件，如下图：
具体Sphinx如何使用以及配置后面会单独文章讲解
主工程
这里讲几个需要注意的地方
1、日志的配置：
这里可以全局设置日志的一些输出级别和格式化方式
2、cli文件
这里通过click库来实现
3、二进制文件打包
如上图，有时候我们的工程中会包含二进制文件，也就是非Python代码的文件，这时候如果还是像往常一样打包发布，安装的时候会发现无法找到此文件，所以需要在根目录的MANIFEST.in文件中加入
脚本
如下图，这里的make-release文件主要是用来自动控制版本的，如下图，通过Git 的提交记录了来作为项目的唯一版本号标识，再对 init 文件进行重新写入达到持续集成时版本号自增的目的。
单元测试
test文件夹中存放的就是项目的单元测试文件了，这里就不细展开讲了，后面会具体讲讲如何跟Jenkins集成实现静态代码检查
setup
最重要的就是setup.py这个文件了，项目最后打包发布到pypi仓库主要的配置信息都在这里了，如下图：
这个脚手架的项目地址：https://github.com/logan62334/python-cli-template
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了Python 中使用 argparse 解析命令行参数，argparse 模块是一个强大的命令行参数解析器，还有很多功能没能在这里介绍。下面文化在哪个详细介绍该内容,需要的朋友可以参考一下2021-11-11
这篇文章主要为大家详细介绍了opencv实现图片模糊和锐化操作，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2018-11-11
Python使用__new__()方法为对象分配内存及返回对象的引用示例
这篇文章主要介绍了Python使用__new__()方法为对象分配内存及返回对象的引用,结合实例形式分析了Python对象初始化及内存操作相关使用技巧,需要的朋友可以参考下2019-09-09
python如何实现wifi自动连接,解决电脑wifi经常断开问题
这篇文章主要介绍了python实现wifi自动连接,解决电脑wifi经常断开的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-06-06
这篇文章主要介绍了python中常用检测字符串相关函数,实例汇总了Python针对字符串数字、字母、大小写等常用检测函数,非常具有实用价值,需要的朋友可以参考下2015-04-04
今天小编就为大家分享一篇Golang GBK转UTF-8的例子，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2019-08-08
这篇文章主要介绍了python用Tkinter做自己的中文代码编辑器，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-09-09
这篇文章主要介绍了python实现输入任意一个大写字母生成金字塔的示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-10-10
PDF格式因其跨平台兼容性和丰富的功能集而成为许多行业中的首选文件格式,其中,PDF中的动作（Action） 功能尤为突出,本文将介绍如何使用Python在PDF文档中创建动作,需要的朋友可以参考下2024-09-09
Python的魔法方法，也称为dunder(双下划线)方法，是可以让你对类添加“魔法”的特殊方法。本文主要来和大家聊聊魔法方法的使用，需要的可以参考一下2022-12-12
最新评论