帮助管理项目的一组cli命令
peltak的Python项目详细描述
peltak是一个命令行工具,可以自动执行许多与项目相关的任务。 该工具应该只封装现有的项目工具,而不是试图替换它们。 另外,在实现新命令时,倾向于只调用外部工具 而不是通过api接口。这样,命令实现 在结构上应该类似于shell脚本,也可以作为参考 如何在不使用peltak的情况下调用相应的第三方工具。 Docker命令是一个很好的例子,因为Docker有很好的Python支持 但是通过阅读命令实现,您知道应该如何处理 手动操作,您甚至不必了解python。
warning:beta:该项目主要缺乏良好的文档和 教程。命令本身有很好的文档记录,但是 没有关于如何扩展和定制Peltak的通用文档或指南。
现在只有peltak.core经过单元测试。命令本身是 在使用Peltak进行日常管理的多个项目中手动测试 然后ci跑了。在1.0之前,还应该对命令实现进行单元测试。 只有cli接口不应该这样做(如果有的话,e2e将对此进行测试)。
注意
可以找到Circleci构建 here
安装
$ pip install peltak
启用自动完成
peltak由于底层的click库,有一个很好的自动完成功能。 启用它的步骤略有不同,具体取决于您正在使用的shell
bash用户
Either run this command or to make the change permanent add it to your ^{tt2}$:
eval"$(_PELTAK_COMPLETE=source peltak)"
- zsh用户
运行此命令或使更改永久添加到 ~/.zshrc:
eval"$(_PELTAK_COMPLETE=source_zsh peltak)"
贡献
设置开发回购
$ git clone git@github.com:novopl/peltak.git $ cd peltak $ virtualenv env $ source ./env/bin/activate $ pip install -r requirements.txt -r ops/devrequirements.txt $ peltak git add-hooks
运行测试
config:测试类型在pelconf.py和 pytest配置在ops/tools/pytest.ini中定义。
$ peltak test
如何测试所有受支持的python版本?
要运行tox,首先需要生成需求文件。你 可以用pipenv lock -d--requirements > requirements.txt来完成。一次 完成了,您可以运行tox来测试python2.7、python3.4 和Python3.6一起。
起毛
config:要lint的位置列表在pelconf.py中定义,并且 linters配置在ops/tools/{pylint,pep8}.ini中定义。
$ peltak lint
生成文档
config:文档文件和常规配置的列表位于 pelconf.py,sphinx配置在docs/conf.py中定义。
$ peltak docs