boardtty是脚本的基于控制台的接口。
boartt的Python项目详细描述
Boartty是脚本任务跟踪的基于控制台的接口 系统。
与Web界面相比,它的主要优点是:
- Workflow – the interface is designed to support a workflow similar to reading network news or mail. In particular, it is designed to deal with a large number of stories across a large number of projects.
- Offline Use – Boartty syncs information about changes in subscribed projects to a local database. All review operations are performed against that database and then synced back to Storyboard.
- Speed – user actions modify locally cached content and need not wait for server interaction.
安装
源代码
从源安装时,建议(但不是必需的)执行以下操作 在虚拟机中安装Boartty。设置一个:
virtualenv boartty-env source boartty-env/bin/activate
从cheeseshop安装最新版本:
pip install boartty
从git签出安装:
pip install .
boartty使用基于yaml的配置文件来查找 ~/.boartty.yaml。包括几个示例配置文件。 您可以在 source distribution 或安装后的share/boartty/examples目录。
选择一个示例配置文件,将其复制到~/.boartty.yaml并 根据需要进行编辑。搜索CHANGEME以查找 需要提供。示例配置文件如下:
- minimal boartty.yaml
- 仅包含Boartty实际运行所需的参数。
- reference boartty.yaml
- 所有受支持选项的详尽列表及示例。
- openstack boartty.yaml
- 设计用于OpenStack安装的配置 格瑞特
您需要一个脚本身份验证令牌,可以生成 或者通过导航到Profile,然后Tokens(“key”)检索 图标),或访问/!/简介/标记故事板中的uri 安装。如果您以前没有这样做过,请发行新的令牌,并且 给它足够长的寿命(例如,十年)。拷贝 并将生成的标记粘贴到~/.boartty.yaml文件中。
配置文件设计为支持多个脚本实例。 默认情况下使用第一个,但其他可以通过 在命令行上提供名称。
用法
安装boartty之后,应该可以通过调用 boartty。如果将其安装在virtualenv中,则可以调用它 不使用^{tt7}激活virtualenv$ 您可能希望将其添加到shell别名中。使用boartty --help查看可用的命令行选项列表。
一旦Boartty开始运行,您需要先订阅一些 项目。使用“l”列出所有项目,然后使用“s”列出 订阅你感兴趣的。再按一次“L”就缩小了 已订阅项目的列表。
通常,按F1键将在任何屏幕上显示帮助文本,并且 esc将带您进入上一个屏幕。
Boartty可以在离线或在线状态下无缝工作。所有的行动 它的执行首先记录在本地数据库中(在 ~/.boartty.db默认情况下),然后传输到脚本。 如果Boartty由于任何原因无法联系Storyboard,它将 继续对本地数据库进行操作,一旦 重新建立联系人,它将处理任何挂起的更改。
屏幕顶部的状态栏显示 船厂必须完成的突出任务 日期。其中一些任务比其他任务更复杂,还有一些 它们中的一个最终将创建新任务(例如,一个任务可能是 在一个项目中搜索新故事,然后生成5个新故事 任务(如果有5个新故事)。
如果boartty离线,它将在状态栏中显示。会的 如果需要,请重试请求,并将在脱机和联机之间切换 模式自动。
如果Boartty遇到错误,也将在 状态栏。您可能希望检查~/.boartty.log以查看 错误是。在很多情况下,当遇到 错误。当您离开当前 屏幕。
要选择文本(例如,要复制到剪贴板),请在按住SHIFT键的同时 选择文本。
如果使用rxvt unicode,可以添加如下内容 .Xresources生成在 终端(可能在电子邮件或irc客户端中)打开的可点击链接 船上:
URxvt.perl-ext: default,matcher URxvt.url-launcher: sensible-browser URxvt.keysym.C-Delete: perl:matcher:last URxvt.keysym.M-Delete: perl:matcher:list URxvt.matcher.button: 1 URxvt.matcher.pattern.1: https:\/\/storyboard.example.org/#!/story/(\\d+)[\w]* URxvt.matcher.launcher.1: boartty --open $0
你需要调整模式以匹配你的故事板站点 感兴趣;可以根据需要添加多个模式。
贡献
有关如何为Boartty做出贡献的信息,请参见 contributing.rst文件的内容。