Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flashcode/gitchart

Build SVG charts from a Git repository.
https://github.com/flashcode/gitchart

chart git python statistics svg

Last synced: 5 days ago
JSON representation

Build SVG charts from a Git repository.

Host: GitHub
URL: https://github.com/flashcode/gitchart
Owner: flashcode
License: gpl-3.0
Created: 2013-03-15T19:38:15.000Z (almost 12 years ago)
Default Branch: main
Last Pushed: 2024-10-19T14:17:32.000Z (4 months ago)
Last Synced: 2025-01-29T14:07:01.516Z (13 days ago)
Topics: chart, git, python, statistics, svg
Language: Python
Homepage:
Size: 137 KB
Stars: 56
Watchers: 5
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Gitchart

[![PyPI](https://img.shields.io/pypi/v/gitchart.svg)](https://pypi.org/project/gitchart/)
[![Build Status](https://github.com/flashcode/gitchart/workflows/CI/badge.svg)](https://github.com/flashcode/gitchart/actions?query=workflow%3A%22CI%22)
[![CodeQL](https://github.com/flashcode/gitchart/workflows/CodeQL/badge.svg)](https://github.com/flashcode/gitchart/actions?query=workflow%3A%22CodeQL%22)

Gitchart is a Python script to build charts from a Git repository.

It can build following charts, as SVG or PNG:

- authors, processed tickets by author (pie charts)
- commits by hour of day, day, day of week, month of year, year, year/month (bar charts)
- commits by hour of week (dot chart)
- files by type (pie chart)

## Requirements

Gitchart requires:

- Python ≥ 3.6
- [Pygal](http://www.pygal.org/) (`pip install pygal`)

Optional dependencies:

- cairosvg, to generate PNG files

## Install

You can install Gitchart with this command from the source repository:

```
$ python setup.py install
```

## Usage

See output of command:

```
$ gitchart --help
```

## Examples

Generate pie chart with authors:

```
$ gitchart --title "Git authors on project X" --repo /path/to/gitrepo/ authors authors.svg
```

Generate bar chart with commits by year using dark style:

```
$ gitchart --style gitchart_dark --repo /path/to/gitrepo/ commits_year commits_year.svg
```

Generate bar chart with commits by version (git tag):

```
$ cd /path/to/gitrepo/
$ git tag | gitchart commits_version /tmp/commits_version.svg
```

## Demo

Gitchart is used to build statistics for WeeChat: https://weechat.org/dev/stats/

## Copyright

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .