Metadata-Version: 2.1
Name: gitink
Version: 0.2.2
Summary: gitink: ASCII to SVG Git log graph visualizer.
Author-email: Radovan Bast <radovan.bast@uit.no>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Requires-Dist: click
Requires-Dist: ascii2graph
Project-URL: Home, https://github.com/bast/gitink

[![image](https://github.com/bast/gitink/workflows/Test/badge.svg)](https://github.com/bast/gitink/actions)
[![image](https://img.shields.io/badge/license-%20MPL--v2.0-blue.svg)](LICENSE)
[![PyPI badge](https://badge.fury.io/py/gitink.svg)](https://badge.fury.io/py/gitink)


# gitink

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


## Example

```console
$ cat example.txt

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

```bash
$ gitink --in-file=example.txt | display
```

This produces (display command requires
[imagemagick](https://www.imagemagick.org)):

![git log graph example](img/example.jpg)


## Available options

```console
$ 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).
                            Default: 90 (right).
  --help                    Show this message and exit.
```


## Installation

```bash
$ pip install gitink
```


## How do the colors work?

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


## Other projects that are interesting

- [Asciio](https://nkh.github.io/P5-App-Asciio/): this project has a [Git
  mode](https://nkh.github.io/P5-App-Asciio/modes/git.html) and can be
  scripted [using the
  API](https://nkh.github.io/P5-App-Asciio/for_developers/scripting.html) to
  generate graphs.

