reviewstats/README.rst
Matt Riedemann 73d434b28c Add the ability to get reviewer stats across all stable branches
This adds a special "all" stable branch value handling for the
reviewers entrypoint. This allows one to do something like:

$ reviewers --stable all --days 90 --output ~/stable-all-reviewers-90

It would be nice to be able to specify a specific project, like nova,
with --stable but that is another change for another day.

Change-Id: I045e982e587c9fb2c53a9cb587f944f09c2c5793
2017-08-30 13:58:37 -04:00

48 lines
1.2 KiB
ReStructuredText

===========
reviewstats
===========
Utility scripts for generating stats about OpenStack development.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/reviewstats
Features
--------
* `openreviews.py` - Get some stats on the number and age of open reviews.
* `reviewers.py` - See how many reviews each person has done over a period of time.
Usage
-----
Clone the git repository, then install the library::
pip install .
Run the scripts.
Project definitions
-------------------
Each project has a JSON file describing what reviews, bugs and so on will count
towards that projects statistics. The JSON file should have a single top level
object containing the following keys:
* name: The project name.
* subprojects: A list of Gerrit projects to include.
* core-team: A list of Gerrit usernames to consider as core reviewers across
subprojects.
* lp_projects: A list of Launchpad project ids to include.
Examples
--------
#. Get reviewer stats for the last 14 days (default) in the stable/pike branch:
``$ reviewers --stable pike --output ~/reviewers-stable-pike-14``
#. Get reviewer stats for the last 90 days across all stable branches:
``$ reviewers --stable all --days 90 --output ~/reviewers-stable-all-90``