|
1 | | -= gitchart |
2 | | -:author: Sébastien Helleu |
3 | | - |
4 | | -:lang: en |
| 1 | +# gitchart |
5 | 2 |
|
6 | | -image:https://img.shields.io/pypi/v/gitchart.svg["PyPI", link="https://pypi.org/project/gitchart/"] |
7 | | -image:https://github.com/flashcode/gitchart/workflows/CI/badge.svg["CI", link="https://github.com/flashcode/gitchart/actions"] |
| 3 | +[](https://pypi.org/project/gitchart/) |
| 4 | +[](https://github.com/flashcode/gitchart/actions?query=workflow%3A%22CI%22) |
8 | 5 |
|
9 | 6 | Gitchart is a Python script to build charts from a Git repository. |
10 | 7 |
|
11 | 8 | It can build following charts, as SVG or PNG: |
12 | 9 |
|
13 | | -* authors, processed tickets by author (pie charts) |
14 | | -* commits by hour of day, day, day of week, month of year, year, year/month |
15 | | - (bar charts) |
16 | | -* commits by hour of week (dot chart) |
17 | | -* files by type (pie chart) |
| 10 | +- authors, processed tickets by author (pie charts) |
| 11 | +- commits by hour of day, day, day of week, month of year, year, year/month (bar charts) |
| 12 | +- commits by hour of week (dot chart) |
| 13 | +- files by type (pie chart) |
18 | 14 |
|
19 | | -== Requirements |
| 15 | +## Requirements |
20 | 16 |
|
21 | 17 | Gitchart requires: |
22 | 18 |
|
23 | | -* Python >= 2.7 |
24 | | -* http://pygal.org/[Pygal] (`pip install pygal`) |
| 19 | +- Python ≥ 2.7 |
| 20 | +- http://pygal.org/[Pygal] (`pip install pygal`) |
25 | 21 |
|
26 | 22 | Optional dependencies: |
27 | 23 |
|
28 | | -* cairosvg, to generate PNG files |
| 24 | +- cairosvg, to generate PNG files |
29 | 25 |
|
30 | | -== Install |
| 26 | +## Install |
31 | 27 |
|
32 | 28 | You can install gitchart with this command from the source repository: |
33 | 29 |
|
34 | | ----- |
| 30 | +``` |
35 | 31 | $ python setup.py install |
36 | | ----- |
| 32 | +``` |
37 | 33 |
|
38 | | -== Usage |
| 34 | +## Usage |
39 | 35 |
|
40 | 36 | See output of command: |
41 | 37 |
|
42 | | ----- |
| 38 | +``` |
43 | 39 | $ gitchart -h |
44 | | ----- |
| 40 | +``` |
45 | 41 |
|
46 | | -== Examples |
| 42 | +## Examples |
47 | 43 |
|
48 | 44 | Generate pie chart with authors: |
49 | 45 |
|
50 | | ----- |
| 46 | +``` |
51 | 47 | $ gitchart -t "Git authors on project X" -r /path/to/gitrepo/ authors authors.svg |
52 | | ----- |
| 48 | +``` |
53 | 49 |
|
54 | 50 | Generate bar chart with commits by year: |
55 | 51 |
|
56 | | ----- |
| 52 | +``` |
57 | 53 | $ gitchart -r /path/to/gitrepo/ commits_year commits_year.svg |
58 | | ----- |
| 54 | +``` |
59 | 55 |
|
60 | 56 | Generate bar chart with commits by version (git tag): |
61 | 57 |
|
62 | | ----- |
| 58 | +``` |
63 | 59 | $ cd /path/to/gitrepo/ |
64 | 60 | $ git tag | gitchart commits_version /tmp/commits_version.svg |
65 | | ----- |
| 61 | +``` |
66 | 62 |
|
67 | | -== Demo |
| 63 | +## Demo |
68 | 64 |
|
69 | 65 | Gitchart is used to build statistics for WeeChat: https://weechat.org/dev/stats/ |
70 | 66 |
|
71 | | -== Copyright |
| 67 | +## Copyright |
72 | 68 |
|
73 | | -Copyright (C) 2013-2020 Sébastien Helleu <[email protected]> |
| 69 | +Copyright © 2013-2020 [Sébastien Helleu](https://github.com/flashcode) |
74 | 70 |
|
75 | 71 | This program is free software; you can redistribute it and/or modify |
76 | 72 | it under the terms of the GNU General Public License as published by |
|
0 commit comments