Skip to main content

ghutter is a tool to recreate the history of a GitHub repository

Project description

GHutter

GHutter is a tool to recreate the history graph of a GitHub repository in Graphviz's Dot Language

Install

Ghutter is available on PyPI

pip install ghutter

Usage

usage: python -m ghutter [-h] [-t TOKEN] [--max-commits MAXCOMMITS] [-d DOTOUTPUT] [-o DRAWOUTPUT] repository

'GHutter' is a tool to recreate the history graph of a GitHub repository in Graphviz's Dot Language

positional arguments:
  repository            github repository in format "owner/repository" or url

options:
  -h, --help            show this help message and exit
  -t TOKEN, --token TOKEN
                        github personal access token
  --max-commits MAXCOMMITS
                        max number of commits to fetch from the history. If it is omitted it tries to fetch the whole
                        history (parents will always be shown)
  -d DOTOUTPUT, --dot-output DOTOUTPUT
                        graph dot file output path (default 'history.dot')
  -o DRAWOUTPUT, --draw-output DRAWOUTPUT
                        graph render output path (there may be several). Check 'Graphviz' supported formats on your
                        system

Example

python -m ghutter -t <token> --max-commits 1000 -d history_graph.dot -o history.svg -o history.png archlinux/linux

License

This project is licensed under the terms of the GPL-3.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghutter-0.1.1.tar.gz (16.9 kB view hashes)

Uploaded Source

Built Distribution

ghutter-0.1.1-py3-none-any.whl (19.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page