Statistics and Metrics for SUSE documentation team.

• Free software: GPL 3.0

The script docstats performs the following tasks:

1. Clone the repositories that are found in the configuration file.

#. Iterate through all repositories and do:

1. Collect the diff statistics.
2. Collect the overall committers (usually reduced to team members only).
3. Collect bugtracker issue numbers from commit messages.

1. Output as JSON or CSV file.

To use the program without 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 pip and virtual environment, use the following command after cloning this repository:

$ PYTHONPATH=src python3 -m docstats -h

To install docstats, use the following steps:

1. Clone this repository:

   $ git clone http://github.com/openSUSE/docstats.git
   $ cd docstats

2. Create a Python 3 environment and activate it:

   $ python3 -m venv .env
   $ source .env/bin/activate

3. Optionally update the pip and setuptools modules:

   $ pip install -U pip setuptools

4. 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 docstats is available.

The script performs the following steps:

1. Clone all definied repositories into a temporary directory. The definied repositories are extraced from a configuration file.
2. Iterate through all cloned repositories.
3. Iterate through all commits in a single repository and extract diff statistics, issues, committers, and other useful information.
4. Perform statistical calculations.
5. Print all the collected information.

To contribute to this project, open issues or send us pull requests. Thanks!