用于命令行工具的命令行工具
pype-cli的Python项目详细描述
Pype
A command-line tool for command-line tools
disclaimer:此项目是早期的poc,接口可以随时更改。
简而言之
pype cli是一个cli可配置的命令行工具,用于管理其他命令行工具集。它简化了开发工作、流程自动化等所需的python脚本的创建、编排和访问。
安装
当前可以使用./make install
从源代码安装pype cli。请注意,如果pipenv不存在,安装程序将提示您输入sudo密码以全局安装它。
在将来的版本中,核心包将可以使用python3 -m pip install pype-cli
或pip3 install pype-cli
安装。
用法
pype cli建立在plugins和pypes之上。pype是一个python脚本,而plugin基本上是一个python模块,它用一个pype cli集合扩展pypes。
pype cli附带一个名为^{cd4>}的内置plugin插件,用于配置pype cli。所有必需的信息都将存储到默认为~/.pype-config.json
的本地json配置文件中。要配置自定义配置文件,请使用环境变量PYPE_CONFIGURATION_FILE
,例如在~/.bashrc
文件集中export PYPE_CONFIGURATION_FILE=/path/to/myconfig.json
。
基本操作
- 列出所有可用的pypes:
pype -l
- 打开pype cli的配置文件:
pype -o
- 有关命令行的详细信息,请参阅
pype ... -h
安装pype自动完成和别名
^ {STR 1 } $ Pype CLI 的主要好处是可以用自定义^ {STR 1 } $插件< /强>进行扩展,并且它将允许您立即浏览并使用新创建的和现有的^ {STR 1 } $插件< /强> /^ {STR 1 } $ PYPES<强>,使用^ {CD12>}键和配置短^ {STR 1 } $别名< /强>。要启用该功能,需要将源脚本安装到shell的rc文件中,该文件将在每次打开shell时执行。
- 运行
pype pype.config shell-install
- 如有必要,运行
pype pype.config shell-uninstall
以删除
取消/注册插件
- 注册现有的^ {STR 1 } $插件/强>:^ {< CD15> }(^ {< CD16> }是一个Python模块,其中至少有一个^ {{CD17}}文件,^ {< CD18> }一个文件夹,其中存储了{{ STR 1 } $插件/Stult>)
- 动态创建并注册一个新的plugin:
pype pype.config plugin-register -c -n myplugin -p ~/pype_plugins
- 注销(但不删除)aplugin:
pype pype.config plugin-unregister -n myplugin
创建、打开和删除pypes
要创建新的pype,您需要决定要将pype添加到哪个插件,例如myplugin
。
- 从模板创建新的pype:
pype myplugin -c mypype
- 从模板创建一个新的pype模板,模板较少:
pype myplugin --minimal -c mypype
或pype myplugin -mc mypype
- 从最小模板创建一个新的pype并立即打开:
pype myplugin --minimal --edit -c mypype
或pype myplugin -mec mypype
- 在默认编辑器中打开pype:
pype myplugin -o mypype
- 删除pype:
pype myplugin -d mypype
取消/注册别名
如果从plugin中选择了pype,则可以为其设置aliases。之后,您需要启动一个新的shell会话,或者从rc文件的源代码中激活别名。新的别名存储在配置文件中。
- 注册一个别名:
pype -r mm myplugin mypype
→alias mm="pype myplugin mypype"
- 使用选项注册一个别名:
pype -r mm myplugin mypype -o opt1 -v
→alias mm="pype myplugin mypype -o opt1 -v"
- 注销别名:
pype -u mm
插件共享代码
如果您的plugin包含所有共享代码pypes您可以简单地将它放入plugin的子包中或以__
为前缀的文件中,例如__commons__.py
。pype cli将只扫描/考虑不带下划线的顶级python脚本作为pypes。
开发
- 运行
./make shell
以打开具有所需外壳配置的pipenv
外壳 - 运行
pype
以操作区域设置开发版本(它将对代码更改作出反应)
许可和归属
此软件是根据Apache License 2.0授权的。
由Freepik从Flaticon制作的图标由CC 3.0 BY授权。