Metadata-Version: 2.1
Name: gitvis
Version: 0.1.1
Summary: A CLI made with Python to visualize your Git commits
Home-page: https://github.com/aldinash
Author: Aldinash Seitenov
Author-email: aldinash.seitenov@gmail.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1.7
Requires-Dist: colorama>=0.4.6
Requires-Dist: gitdb>=4.0.11
Requires-Dist: GitPython>=3.1.43
Requires-Dist: smmap>=5.0.1
Requires-Dist: setuptools>=70.1.1


# GitVis

GitVis is a tool that allows you to visualize your local commits for the last 6 months from a given date. The visualization is done in a manner similar to GitHub and GitLab, providing a familiar and intuitive interface.

The code is fully written in Python and is inspired by [gitcs](https://github.com/knbr13/gitcs).

## Demo
![gitvis](https://github.com/aldinash/gitvis/blob/main/gitvis.gif?raw=true)

Note that colors are highly dependent on the ANSI escape sequences of your terminal.

## Installation

The CLI is distributed via PyPi. To install the package:

```sh
pip install gitvis
```

Make sure to use virtual environments for better dependency management.

## Usage

The basic usage is straightforward. Simply run:

```sh
gitvis
```

GitVis will scan for `.git` folders in your current directory and use the global email for the contributions graph.

To run the tool with custom options, use the flags as shown below:

```sh
gitvis -d /home/user/directory --email example@email.com --since 01-14-2024
```

If you don't remember the flags, just run:

```sh
gitvis --help
```

## Future Plans

The project is still in its early stages, and it would be great to develop a tool that visualizes the entire Git workflow locally in the terminal. If you are interested in contributing to such tools, feel free to DM me.

## License

MIT
