Data

Tools

Indexes

Applications

Experiments

Open Source Science

gg

Git and GitHub for the productivity addicted

https://github.com/peterbe/gg

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Git and GitHub for the productivity addicted

Basic Info
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 10 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.rst 

==
gg
==

.. image:: https://github.com/peterbe/gg/workflows/Python/badge.svg
    :target: https://github.com/peterbe/gg/actions

.. image:: https://badge.fury.io/py/gg.svg
    :target: https://pypi.python.org/pypi/gg

Git and GitHub command line swiss army knife for the productivity addicted.

``gg`` is a base command, and all the work to create branches, list branches,
clean up branches, connect to Bugzilla etc. are done by
`plugins `_.

``gg`` is stateful. Meaning, plugins (not all!) need to store additional
information that is re-used for other commands. For example, to
connect to your GitHub account might need to store a GitHub Access Token.


Installation
============

``gg`` requires Python 3.

The idea is that you install ``gg`` globally::

    sudo pip install gg

But that's optional, you can also just install it in your current
virtual environment::

    pip install gg

If you don't want to install ``gg`` and its dependencies in either the
current working virtual environment *or* in your global system Python,
you can first install `pipx `_
then once you've installed and set that up::

    pipx install gg

Next, you need to install some plugins. See
`PLUGINS.rst `_
for a list of available plugins.

Bash completion
===============

First download
`gg-complete.sh `_
and save it somewhere on your computer. Then put this line into your `.bashrc`
(or `.bash_profile` if you're on OSX)::

    source /path/to/gg-complete.sh


How to develop
==============

To work on this, first run::

    pip install -U --editable .

Now you can type::

    gg --help

If you have install more plugins they will be listed under the same
``--help`` command.

Linting
=======

This project tracks `black `_ and expects
all files to be as per how ``black`` wants them. Please see its repo for how to
set up automatic formatting.

All code needs to be ``flake8`` conformant. See ``setup.cfg`` for the rules.

To test both, run::

    tox -e lint


How to write a plugin
=====================

To write your own custom plugin, (similar to ``gg/builtins/commands/commit``)
these are the critical lines you need to you have in your ``setup.py``::

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

This assumes you have a file called ``gg_myplugin.py`` that has a function
called ``start``.

Version History
===============

0.1
  * Proof of concept

Owner

  • Name: Peter Bengtsson
  • Login: peterbe
  • Kind: user
  • Location: South Carolina, USA
  • Company: GitHub

Full-stack web dev working on GitHub Docs. Formerly Mozilla, MDN. Loves Python, PWAs, Postgres, Node, Search, and wants to learn everything.

GitHub Events

Total
Last Year

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 134
  • Total Committers: 2
  • Avg Commits per committer: 67.0
  • Development Distribution Score (DDS): 0.022
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Peter Bengtsson m****l@p****m 131
Peter Bengtsson p****e@m****m 3
Committer Domains (Top 20 + Academic)
mozilla.com: 1 peterbe.com: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 31
  • Average time to close issues: N/A
  • Average time to close pull requests: 22 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.13
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • peterbe (31)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 757 last-month
  • Total docker downloads: 128
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 21
  • Total maintainers: 1
pypi.org: gg

Git and GitHub for the productivity addicted

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 757 Last month
  • Docker Downloads: 128
Rankings
Docker downloads count: 3.0%
Dependent repos count: 7.5%
Dependent packages count: 10.0%
Average: 16.0%
Downloads: 22.5%
Stargazers count: 23.1%
Forks count: 29.8%
Maintainers (1)
peterbe
Last synced: 11 months ago

Dependencies

setup.py pypi
  • click *
.github/workflows/python.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite