gitstats


Namegitstats JSON
Version 0.7.3 PyPI version JSON
download
home_pageNone
SummaryGitStats - Visualize Your Git Repositories
upload_time2025-08-22 23:09:11
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords git gitstats statistics git history
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. 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

.. |python-download| image:: https://static.pepy.tech/badge/gitstats/week
   :target: https://pepy.tech/projects/gitstats
   :alt: PyPI Downloads

.. |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| |python-download| |test-badge| |docs-badge| |contributors|

📊 Generate insightful visual reports from Git.

📘 Documentation: `gitstats.readthedocs.io <https://gitstats.readthedocs.io/>`_

Example
-------

``gitstats . report`` generates this `gitstats report <https://shenxianpeng.github.io/gitstats/index.html>`_.

Installation
------------

.. code-block:: bash

   pip install gitstats


gitstats is compatible with Python 3.9 and newer.


Usage
-----

.. code-block:: bash

   gitstats <gitpath> <outputpath>


Run ``gitstats --help`` for more options, or check the `documentation <https://gitstats.readthedocs.io/en/latest/usage.html>`_.


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 <https://github.com/hoxu>`_ and is currently maintained by `Xianpeng Shen <https://github.com/shenxianpeng>`_.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gitstats",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "git, gitstats, statistics, git history",
    "author": null,
    "author_email": "Xianpeng Shen <xianpeng.shen@gmail.com>, Heikki Hokkanen <hoxu@users.sf.net>",
    "download_url": null,
    "platform": null,
    "description": ".. start-of-about\n\n.. image:: https://raw.githubusercontent.com/shenxianpeng/gitstats/main/docs/source/logo.png\n   :alt: Project Logo\n   :align: center\n   :width: 200px\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/gitstats?color=blue\n   :target: https://pypi.org/project/gitstats/\n   :alt: PyPI - Version\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/gitstats\n   :alt: PyPI - Python Version\n\n.. |python-download| image:: https://static.pepy.tech/badge/gitstats/week\n   :target: https://pepy.tech/projects/gitstats\n   :alt: PyPI Downloads\n\n.. |test-badge| image:: https://github.com/shenxianpeng/gitstats/actions/workflows/test.yml/badge.svg\n   :target: https://github.com/shenxianpeng/gitstats/actions/workflows/test.yml\n   :alt: Test\n\n.. |sonarcloud| image:: https://sonarcloud.io/api/project_badges/measure?project=shenxianpeng_gitstats&metric=alert_status\n   :target: https://sonarcloud.io/summary/new_code?id=shenxianpeng_gitstats\n   :alt: Quality Gate Status\n\n.. |docs-badge| image:: https://readthedocs.org/projects/gitstats/badge/?version=latest\n   :target: https://gitstats.readthedocs.io/\n   :alt: Documentation\n\n.. |contributors| image:: https://img.shields.io/github/contributors/shenxianpeng/gitstats\n   :target: https://github.com/shenxianpeng/gitstats/graphs/contributors\n   :alt: GitHub contributors\n\n|pypi-version| |python-versions| |python-download| |test-badge| |docs-badge| |contributors|\n\n\ud83d\udcca Generate insightful visual reports from Git.\n\n\ud83d\udcd8 Documentation: `gitstats.readthedocs.io <https://gitstats.readthedocs.io/>`_\n\nExample\n-------\n\n``gitstats . report`` generates this `gitstats report <https://shenxianpeng.github.io/gitstats/index.html>`_.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n   pip install gitstats\n\n\ngitstats is compatible with Python 3.9 and newer.\n\n\nUsage\n-----\n\n.. code-block:: bash\n\n   gitstats <gitpath> <outputpath>\n\n\nRun ``gitstats --help`` for more options, or check the `documentation <https://gitstats.readthedocs.io/en/latest/usage.html>`_.\n\n\nFeatures\n--------\n\nHere is a list of some features of ``gitstats``:\n\n* **General**: total files, lines, commits, authors, age.\n* **Activity**: commits by hour of day, day of week, hour of week, month of year, year and month, and year.\n* **Authors**: list of authors (name, commits (%), first commit date, last commit date, age), author of month, author of year.\n* **Files**: file count by date, extensions.\n* **Lines**: line of code by date.\n* **Tags**: tags by date and author.\n* **Customizable**: config values through ``gitstats.conf``.\n* **Cross-platform**: works on Linux, Windows, and macOS.\n\n.. end-of-about\n\nContributing\n------------\n\nAs an open source project, gitstats welcomes contributions of all forms.\n\n----\n\nThe gitstats project was originally created by `Heikki Hokkainen <https://github.com/hoxu>`_ and is currently maintained by `Xianpeng Shen <https://github.com/shenxianpeng>`_.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "GitStats - Visualize Your Git Repositories",
    "version": "0.7.3",
    "project_urls": {
        "documentation": "https://gitstats.readthedocs.io/",
        "homepage": "https://shenxianpeng.github.io/gitstats/main/index.html",
        "source": "https://github.com/shenxianpeng/gitstats",
        "tracker": "https://github.com/shenxianpeng/gitstats/issues"
    },
    "split_keywords": [
        "git",
        " gitstats",
        " statistics",
        " git history"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5bfe8efa30d4a3a8167217eaec71543109a81f3749700011646220cb97085cc7",
                "md5": "add39e201f797c98a02d5f171fea088c",
                "sha256": "3693c7e1b7930b2f1ad65ae0d6d1746a44b25478a0f006e33f50800f14fc84dc"
            },
            "downloads": -1,
            "filename": "gitstats-0.7.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "add39e201f797c98a02d5f171fea088c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 23658,
            "upload_time": "2025-08-22T23:09:11",
            "upload_time_iso_8601": "2025-08-22T23:09:11.743340Z",
            "url": "https://files.pythonhosted.org/packages/5b/fe/8efa30d4a3a8167217eaec71543109a81f3749700011646220cb97085cc7/gitstats-0.7.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-22 23:09:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "shenxianpeng",
    "github_project": "gitstats",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gitstats"
}
        
Elapsed time: 0.63094s