https://github.com/robertobochet/ghutter

GHutter is a tool to recreate the history graph of a GitHub repository in graphviz dot format
https://github.com/robertobochet/ghutter

Last synced: 14 days ago
JSON representation

GHutter is a tool to recreate the history graph of a GitHub repository in graphviz dot format

• Host: GitHub
• URL: https://github.com/robertobochet/ghutter
• Owner: RobertoBochet
• License: gpl-3.0
• Created: 2023-08-31T16:50:30.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-31T18:59:19.000Z (over 1 year ago)
• Last Synced: 2024-11-02T17:42:51.339Z (2 months ago)
• Language: Python
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

```bash

pip install ghutter

```

Anymore `GHutter` requires `graphviz` is installed on you system in order to render the graphs. Refer to [Graphviz documentation](https://graphviz.org/download/) for more information

## Usage

```text

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

```bash

python -m ghutter -t  --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.