Skip to main content

Hubtty 是 Github 代码审查系统的基于控制台的界面。

项目描述

Hubtty 是 Github 代码审查系统的基于控制台的界面。

与Web界面相比,主要优点是:

  • 工作流程——该界面旨在支持类似于阅读网络新闻或邮件的工作流程。特别是,它旨在处理大量存储库中的大量审查请求。

  • 离线使用 – Hubtty 将有关订阅存储库中的拉取请求的信息同步到本地数据库和本地 git 存储库。所有审查操作都针对该数据库执行,然后同步回 Github。

  • 速度——用户操作修改本地缓存的内容,无需等待服务器交互。

  • 方便——因为 Hubtty 将所有拉取请求下载到本地 git 存储库,一个命令指示它将拉取请求签出到该存储库中,以便详细检查或测试更大的拉取请求。

安装

资源

从源代码安装时,建议(但不是必需)将 Hubtty 安装在 virtualenv 中。要设置一个:

virtualenv hubtty-env
source hubtty-env/bin/activate

要从 cheeseshop 安装最新版本:

pip install hubtty

从 git checkout 安装:

pip install .

Hubtty 使用基于 YAML 的配置文件,它在 $XDG_CONFIG_HOME/hubtty/hubtty.yaml中查找。包括几个示例配置文件。你可以在 源码发行版的examples/目录或者安装后的share/hubtty/examples目录中找到它们。

示例配置文件如下:

最小hubtty.yaml

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

参考hubtty.yaml

包含示例的所有支持选项的详尽列表。

openshift-hubtty.yaml

专为 OpenShift 审核而设计的配置。

Hubtty 使用本地 git 存储库来执行其大部分工作。这些可以是您在开发项目时使用的相同 git 存储库。Hubtty 不会更改工作目录或索引,除非您提出要求(即便如此,通常的 git 防止意外丢失工作的保护措施仍然存在)。您需要提供 Hubtty 将在其中查找或克隆项目的 git 存储库的目录名称作为git-root参数。

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

用法

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

Hubtty 运行后,您需要先订阅一些存储库。使用“L”列出所有存储库,然后使用“s”订阅您感兴趣的存储库。再次点击“L”将列表缩小到您订阅的存储库。

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

Hubtty 可以离线或在线无缝工作。它执行的所有操作首先记录在本地数据库中(默认在$XDG_DATA_HOME/hubtty/hubtty.db 中),然后传输到 Github。如果 Hubtty 因任何原因无法联系到 Github,它将继续对本地数据库进行操作,一旦重新建立联系,它将处理任何未决的更改。

屏幕顶部的状态栏显示 Hubtty 必须执行的当前未完成任务的数量才能完全更新。其中一些任务比其他任务更复杂,其中一些最终会创建新任务(例如,一项任务可能是在存储库中搜索新的拉取请求,如果有 5 个新拉取,则该请求将生成 5 个新任务要求)。

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

如果您在离线状态下以赞成票审核拉取请求,而在 Hubtty 能够上传您的评论之前,其他人对该拉取请求投了反对票,那么 Hubtty 将检测到这种情况并将拉取请求标记为“保留”,以便您在上传评论之前,可能会重新检查拉取请求和任何新评论。状态栏会提醒您任何保留的拉取请求,并将您定向到它们的列表(默认为F12键)。查看拉取请求时,可以使用感叹号 ( ! ) 切换“保留”标志。一旦持有,拉取请求必须以这种方式明确取消持有,您的评论才能上传。

如果 Hubtty 遇到错误,也会在状态栏中显示。您可能希望检查$XDG_DATA_HOME/hubtty/hubtty.log以查看错误是什么。在很多情况下,Hubtty 可以在遇到错误后继续。当您离开当前屏幕时,错误标志将被清除。

要选择文本(例如,复制到剪贴板),请在选择文本时按住 Shift。

苹果系统

MacOS 终端阻止 ctrl+o,这是 Hubtty 中的默认搜索键组合。为了解决这个问题,可以在 MacOS 上使用自定义键映射来修改搜索键组合。例如:

keymaps:
  - name: default # MacOS blocks ctrl+o
    pr-search: 'ctrl s'
    interactive-search: 'ctrl i'

贡献

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

错误

错误处理在:https ://github.com/hubtty/hubtty/issues

项目详情


下载文件

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

源分布

hubtty-0.2.0.tar.gz (111.6 kB 查看哈希)

已上传 source

内置分布

hubtty-0.2.0-py3-none-any.whl (118.5 kB 查看哈希

已上传 py3