Simple tool to output a mermaid gantt chart that shows git repo coding runs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img
.gitignore
.pylintrc
LICENSE
Makefile
Pipfile
Pipfile.lock
README.md
git2gantt

README.md

git2gantt

Introduction

git2gantt is a simple tool that's designed to create mermaid gantt chat code from one or more git repositories.

Setup

git2gantt is written in, and requires, Python 3 -- likely Python 3.5 at the oldest. While it should run itself, I've also used pipenv to help control extra things, like being able to easily lint the code.

To set up using pipenv, simply type:

$ make setup

If you need to run pylint over the code, simply type:

$ make lint

Usage

usage: git2gantt [-h] [-a AUTHOR] [-d DESCRIPTION] [-e] [-f FUZZ] [-t TITLE]
                 [-v]
                 repos [repos ...]

git history to mermaid gantt chart tool

positional arguments:
  repos

optional arguments:
  -h, --help            show this help message and exit
  -a AUTHOR, --author AUTHOR
                        Limit to commits by the given author.
  -d DESCRIPTION, --description DESCRIPTION
                        Description to give each session.
  -e, --every-branch    Uses commits for every available branch.
  -f FUZZ, --fuzz FUZZ  Size of a 'fuzzy' period when deciding contiguous
                        days.
  -t TITLE, --title TITLE
                        The title for the chart.
  -v, --version         Show version information.

To produce a gantt chart for a single repository, simply:

$ git2gantt /path/to/repo

The mermaid code will be output. Capture that and run it through mermaid to create the chart. The output will look something like this:

Sample1

It's possible to run git2gantt over more than one repository at a time. For example:

$ git2gantt /path/to/repo1 /path/to/repo2

The resulting output with me something like:

Sample2

The title of the chart can be changed using the --title parameter. The title of each "coding session" can be set with the --description parameter. For other changes to the output, simply edit the output before passing it through Mermaid.

Assumptions

This tool was initially written as a way of visualising the work done on a number of work projects, so for now it concentrates just on work days. What a working day is will be different from person to person, and culture to culture, etc. I aim to carry on working on this tool and make it a lot more flexible in this regard.

This is just an early test to get things up and going.

TODO

  • Be smarter about the concept of a "working day".
  • Allow the option to not even worry about "working days".
  • Add a parameter that gives some wiggle room for a coding session length.
  • Look at including Mermaid such that the output is optionally an actual chart.
  • Have repository checking/cleaning do a bit of a search for the root of the repository -- that way people don't need to specify the root of the repository, just some location within it.