跳转到主要内容

为生产力爱好者提供的Git和GitHub

项目描述

https://github.com/peterbe/gg/workflows/Python/badge.svg https://badge.fury.io/py/gg.svg

Git和GitHub命令行瑞士军刀,专为生产力爱好者设计。

gg 是一个基本命令,创建分支、列出分支、清理分支、连接到Bugzilla等所有工作都是由 插件 完成的。

gg 具有状态。这意味着插件(不是所有!)需要存储额外的信息,这些信息将被其他命令重复使用。例如,连接到您的GitHub账户可能需要存储GitHub访问令牌。

安装

gg 需要 Python 3。

想法是您可以将 gg 全局安装

sudo pip install gg

但这不是必需的,您也可以仅在当前的虚拟环境中安装它

pip install gg

如果您不想在当前工作虚拟环境 在全局系统Python中安装 gg 及其依赖项,您可以先安装 pipx,然后一旦安装并设置好

pipx install gg

接下来,您需要安装一些插件。请参阅 PLUGINS.rst 以获取可用插件的列表。

Bash自动完成

首先下载 gg-complete.sh 并将其保存到您的计算机上的某个位置。然后,将此行放入您的 .bashrc(如果您在OSX上,则为 .bash_profile

source /path/to/gg-complete.sh

如何开发

要工作于此,首先运行

pip install -U --editable .

现在您可以输入

gg --help

如果您安装了更多插件,它们将在相同的 --help 命令下列出。

代码检查

本工程跟踪 black 并期望所有文件都符合 black 的要求。请参阅其仓库以了解如何设置自动格式化。

所有代码都必须符合 flake8 规则。请参阅 setup.cfg 了解规则。

要测试这两个工具,请运行

tox -e lint

如何编写插件

要编写您自己的自定义插件(类似于 gg/builtins/commands/commit),您需要在您的 setup.py 中包含以下关键行

setup(
    ...
    install_requires=['gg'],
    entry_points="""
        [gg.plugin]
        cli=gg_myplugin:start
    """,
    ...
)

这假设您有一个名为 gg_myplugin.py 的文件,其中包含一个名为 start 的函数。

版本历史

0.1
  • 概念验证

项目详情


下载文件

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

源代码分发

gg-0.0.21.tar.gz (22.9 kB 查看哈希值)

上传时间 源代码

构建分发

gg-0.0.21-py3-none-any.whl (27.6 kB 查看哈希值)

上传时间 Python 3

支持者