boartty 0.0.0

安装

源代码

从源代码安装时，建议（但不是必需）在虚拟环境中安装 Boartty。要设置一个

virtualenv boartty-env
source boartty-env/bin/activate

从 cheeseshop 安装最新版本

pip install boartty

从 git 检出安装

pip install .

Boartty 使用基于 YAML 的配置文件，它在 ~/.boartty.yaml 中查找。包括几个示例配置文件。您可以在 源代码分发 或安装后的 share/boartty/examples 目录中找到它们。

选择一个示例配置文件，将其复制到~/.boartty.yaml并按需编辑。搜索CHANGEME以找到需要提供的参数。以下是一些示例配置文件：

minimal-boartty.yaml

仅包含Boartty实际运行所需的参数。

reference-boartty.yaml

所有支持选项的详尽列表以及示例。

openstack-boartty.yaml

为与OpenStack安装的Gerrit一起使用而设计的配置。

您需要一个Storyboard身份验证令牌，您可以通过访问Profile，然后访问Tokens（“key”图标），或访问Storyboard安装中的#!/profile/tokens URI来生成或检索它。如果您之前尚未这样做，请发行一个新的令牌，并给它一个足够长的生命周期（例如，十年）。将生成的令牌复制并粘贴到您的~/.boartty.yaml文件中。

配置文件旨在支持多个Storyboard实例。默认情况下使用第一个，但可以通过在命令行中提供名称来指定其他实例。

用法

安装Boartty后，您可以通过调用boartty来运行它。如果您在virtualenv中安装了它，您可以在不激活virtualenv的情况下调用它，使用/path/to/venv/bin/boartty，您可能希望将其添加到shell别名中。使用boartty --help查看可用的命令行选项列表。

一旦Boartty运行，您需要先订阅一些项目。使用‘L’列出所有项目，然后使用‘s’订阅您感兴趣的项目。再次按‘L’以缩小列表到您订阅的项目。

通常，按F1键将在任何屏幕上显示帮助文本，ESC将带您回到上一个屏幕。

Boartty可以在离线或在线状态下无缝工作。它执行的所有操作首先记录在本地数据库中（默认情况下为~/.boartty.db），然后传输到Storyboard。如果Boartty由于任何原因无法联系Storyboard，它将继续针对本地数据库操作，并在重新建立联系后处理任何挂起的更改。

屏幕顶部的状态栏显示Boartty必须执行以完全更新的当前挂起任务数。其中一些任务比其他任务更复杂，并且其中一些任务最终将创建新任务（例如，一个任务是搜索项目中的新故事，如果有5个新故事，则将产生5个新任务）。

如果Boartty离线，状态栏中也会显示。如果需要，它将重试请求，并自动在离线和在线模式之间切换。

如果Boartty遇到错误，状态栏中也会显示。您可能想检查~/.boartty.log以查看错误是什么。在许多情况下，Boartty在遇到错误后可以继续运行。当您离开当前屏幕时，错误标志将被清除。

要选择文本（例如，复制到剪贴板），在选择文本时按住Shift键。

终端集成

如果您使用rxvt-unicode，您可以将以下内容添加到.Xresources中，以便在您的终端（可能在电子邮件或irc客户端中）显示的可点击链接在Boartty中打开Storyboard URL

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

您需要调整模式以匹配您感兴趣的Storyboard站点；根据需要可以添加多个模式。

贡献

有关如何为Boartty做出贡献的信息，请参阅CONTRIBUTING.rst文件的内容。

错误

错误处理在：https://storyboard.openstack.org/