跳转到主要内容

kiens 是一个基于行的命令解析器,用于创建类似 shell 的界面

项目描述

kien logo

kiens 是一个 python3 库,允许您创建一个基于行的自定义命令解析器,旨在创建类似 shell 的界面。kiens 不是一个 shell,也不试图成为。

如果您想在串行设备上提供一个对人和机器都友好的基于文本的界面,kiens 就是为您准备的。kiens 的最佳场景:您只需编写实际执行任务的代码。

请注意,kiens 正在积极开发中,并且尚未有一个稳定的 API。在我们发布 v1.0.0 之前,在较小的版本之间可能会发生破坏性的更改,但这些更改将在 变更日志 中记录。

kiens 支持

  • (可选)关键词
  • 变量
  • 验证
  • 转换
  • 自动生成帮助和文档
  • 依赖注入
  • 可读性和 JSON 输出
  • TTY 处理

Prompt example showing how the say-some-name example works in action

示例

kiens 主要通过在函数上使用装饰器来工作。请参阅示例文件夹 😊

# run examples with pipenv
pipenv run example examples/say-some-name.py

# or using your shell powers 
# (install dependencies first or initialize and load a virtualenv) 
PYTHONPATH=. python3 examples/say-some-name.py

工作进行中

  • 目前没有测试

    这并不是因为不应该有,而是因为kien最近才从一个只测试kien实际执行命令的应用程序中提取出来。从这个意义上说,有一些测试涵盖了kien的大部分功能,但它们只是不公开。话虽如此:kien应该并且将来会有测试。

  • 输出格式化 & 终端处理

    kien处理终端和如何写入及格式化文本的方式是硬编码的,需要仔细思考和重构。

  • 文档很少

说出我的名字

kien是一个双关语,也是对指挥官Keen的致敬,因为kien的核心部分被称为指挥官。kien在德语中也是一种相当古老的指松树的方式。就是这样:)

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源分布

kien-0.16.3.tar.gz (29.0 kB 查看哈希)

上传

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面