bugdaystats/README.rst
Ken'ichi Ohmichi 28514885b5 Add "daily" option to bugdaystats.py
Recently, we are triaging bugs of Tempest on the launchpad and that
work was fine to clean up old bugs and fixed bugs with different
patches.
Current bugdaystats shows it in last several days statically, and it
would be nice to add more long terms like in 30 days or a release to see
bug triage trends.

This patch adds a "daily" option to bugdaystats.py for making daily data
json files. The file can be used to show long term data in other graphs.

Change-Id: Ieac396389ce13468b717d03264164c77f7c36104
2016-09-20 12:35:53 +02:00

51 lines
1.7 KiB
ReStructuredText

Bug Day Stats page generator
============================
The bugdaystats.py script is used to extract data from Launchpad
and produce static HTML that shows progress during a Bug Day.
Prerequisites
-------------
You'll need the following Python modules installed:
- launchpadlib
- jinja2
Usage
-----
python bugdaystats.py output
'output' is the name of the directory you will generate data
and HTML files to (if they don't exist yet). It should contain a
'js' subdirectory containing JavaScript include files, but
otherwise be empty. In addition, it can contain two types of data
files. One file contains data in each time when running the script,
and another one is created daily. That means the creation is skipped
if the previous data is in the same day. The data file is useful for
showing long-term bug situation.
You'll need to run the script at least twice to generate enough
stats to get a graph.
Stats are updated every time the script is run. You should run
bugdaystats.py regularly over the course of your bugday.
Configuration
-------------
The config.js configuration file describes the projects you want
to generate data for. "height" is an optional parameter detailing
the size of the graph (230 pixels is the default value). "title"
is an optional parameter for the name of the project in the index
page.
You can also optionally specify a 'rotation' parameter. Entries older
than the value (in days) will be removed from the dataset, resulting
in a rolling view of bug activity.
And you can also optionally specify a 'daily' parameter to enable the
feature of daily data collection and showing its graphs.
'daily_rotation' parameter is for daily data collection feature but
it is same as 'rotation' parameter.