https://github.com/shenxianpeng/gitstats

📊 Visualize Your Git Repositories
https://github.com/shenxianpeng/gitstats

git githistory gitstats html-report statistics

Last synced: 5 months ago
JSON representation

📊 Visualize Your Git Repositories

• Host: GitHub
• URL: https://github.com/shenxianpeng/gitstats
• Owner: shenxianpeng
• License: other
• Created: 2019-12-17T08:52:46.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2025-06-17T19:28:15.000Z (5 months ago)
• Last Synced: 2025-06-27T01:07:11.290Z (5 months ago)
• Topics: git, githistory, gitstats, html-report, statistics
• Language: Python
• Homepage: https://gitstats.readthedocs.io/
• Size: 24.4 MB
• Stars: 23
• Watchers: 1
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. start-of-about

.. image:: https://raw.githubusercontent.com/shenxianpeng/gitstats/main/docs/source/logo.png

   :alt: Project Logo

   :align: center

   :width: 200px

.. |pypi-version| image:: https://img.shields.io/pypi/v/gitstats?color=blue

   :target: https://pypi.org/project/gitstats/

   :alt: PyPI - Version

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/gitstats

   :alt: PyPI - Python Version

.. |test-badge| image:: https://github.com/shenxianpeng/gitstats/actions/workflows/test.yml/badge.svg

   :target: https://github.com/shenxianpeng/gitstats/actions/workflows/test.yml

   :alt: Test

.. |sonarcloud| image:: https://sonarcloud.io/api/project_badges/measure?project=shenxianpeng_gitstats&metric=alert_status

   :target: https://sonarcloud.io/summary/new_code?id=shenxianpeng_gitstats

   :alt: Quality Gate Status

.. |docs-badge| image:: https://readthedocs.org/projects/gitstats/badge/?version=latest

   :target: https://gitstats.readthedocs.io/

   :alt: Documentation

.. |contributors| image:: https://img.shields.io/github/contributors/shenxianpeng/gitstats

   :target: https://github.com/shenxianpeng/gitstats/graphs/contributors

   :alt: GitHub contributors

|pypi-version| |python-versions| |test-badge| |docs-badge| |contributors|

📊 Generate insightful visual reports from Git.

📘 Documentation: `gitstats.readthedocs.io `_

Example

-------

``gitstats . report`` generates this `gitstats report `_.

Installation

------------

.. code-block:: bash

   pip install gitstats

gitstats is compatible with Python 3.9 and newer.

Usage

-----

.. code-block:: bash

   gitstats  

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.

.. end-of-about

Contributing

------------

As an open source project, gitstats welcomes contributions of all forms.

----

The gitstats project was originally created by `Heikki Hokkainen `_ and is currently maintained by `Xianpeng Shen `_.