Welcome to GitStats documentation!

Project Logo

PyPI - Version PyPI - Python Version PyPI Downloads Test Documentation GitHub contributors

📊 Generate insightful visual reports from Git.

📘 Documentation: gitstats.readthedocs.io

Example

gitstats . report generates this gitstats report.

Installation

pip install gitstats

gitstats is compatible with Python 3.9 and newer.

Usage

gitstats <gitpath> <outputpath>

Run gitstats --help for more options, or check the documentation.

Features

Here is a list of some features of gitstats:

  • General: total files, lines, commits, authors, age.

  • Activity: commits by hour of day, day of week, hour of week, month of year, year and month, and year.

  • Authors: list of authors (name, commits (%), first commit date, last commit date, age), author of month, author of year.

  • Files: file count by date, extensions.

  • Lines: line of code by date.

  • Tags: tags by date and author.

  • Customizable: config values through gitstats.conf.

  • Cross-platform: works on Linux, Windows, and macOS.

Getting Started

About