Statistics and Metrics for SUSE documentation team.
- Free software: GPL 3.0
The script :command:`docstats` performs the following tasks:
- Clone the repositories that are found in the configuration file.
- Iterate through all repositories and do:
- Collect the diff statistics.
- Collect the overall committers (usually reduced to team members only).
- Collect bugtracker issue numbers from commit messages.
- Output as JSON or CSV file.
To use the program without :command:`pip` and virtual environment (but with all the dependencies), use the following command after cloning this repository:
$ PYTHONPATH=src python3 -m docstats -h
To use the program without :command:`pip` and virtual environment, use the following command after cloning this repository:
$ PYTHONPATH=src python3 -m docstats -h
To install :program:`docstats`, use the following steps:
Clone this repository:
$ git clone http:https://github.com/openSUSE/docstats.git $ cd docstats
Create a Python 3 environment and activate it:
$ python3 -m venv .env $ source .env/bin/activate
Optionally update the
pip
andsetuptools
modules:$ pip install -U pip setuptools
Install the package:
$ ./setup.py develop
If you need to install it from GitHub directly, use this URL:
git+https://github.com/openSUSE/docstats.git@develop
After the installation in your Python virtual environment, the script :program:`docstats` is available.
The script performs the following steps:
- Clone all definied repositories into a temporary directory. The definied repositories are extraced from a configuration file.
- Iterate through all cloned repositories.
- Iterate through all commits in a single repository and extract diff statistics, issues, committers, and other useful information.
- Perform statistical calculations.
- Print all the collected information.
To contribute to this project, open issues or send us pull requests. Thanks!