Skip to main content

ASCII to SVG Git log graph visualizer.

Project description

https://travis-ci.org/bast/gitink.svg?branch=master https://img.shields.io/badge/license-%20MPL--v2.0-blue.svg

gitink

ASCII to SVG Git log graph visualizer. Useful for teaching Git. Under the hood it uses https://github.com/bast/ascii2graph.

Example

$ cat example.txt

                     [feature]
                      |
                      v
               x1-----x2
              /
c1----c2----m1----c3----c4
  \        /            ^
   b1----b2----b3       |
   ^           ^       [master,HEAD]
   |           |
  [_branch]   [branch]

$ gitink --time-direction=90 --in-file=example.txt | display

This produces (display command requires imagemagick):

Git log graph example

Available options

$ gitink --help
Usage: gitink [OPTIONS]

Options:
  --scale FLOAT             Scale sizes by this factor.
  --in-file TEXT            ASCII file to convert.
  --time-direction INTEGER  Direction of the time arrow (0, 90, 180, or 270).
  --help                    Show this message and exit.

Installation

$ pip install gitink

Alternately you can replace master with a branch or a tag.

How do the colors work?

Coloring is done according to the first character of the commit hash. Other suggestions welcome.

I used this code before but the API changed?

You can find the old version on the spaghetti branch.

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

gitink-0.2.0.tar.gz (8.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page