Tool to produce static HTML that shows progress during a Bug Day
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 01e38bd1c2 OpenDev Migration Patch 5 hours ago
output/js Initial import 6 years ago
templates Prettified all HTML files 4 years ago
.gitignore Add .tox dir to .gitignore 2 years ago
.gitreview OpenDev Migration Patch 5 hours ago
LICENSE Initial import 6 years ago
README.rst Add "daily" option to bugdaystats.py 2 years ago
bugdaystats.py Add "daily" option to bugdaystats.py 2 years ago
config.js.sample Add "daily" option to bugdaystats.py 2 years ago
setup.py Add tox.ini, setup.py and do syntax cleanup 5 years ago
tox.ini Add tox.ini, setup.py and do syntax cleanup 5 years ago

README.rst

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.