openstack
/
bugdaystats
Code Issues Proposed changes
Tool to produce static HTML that shows progress during a Bug Day
5 Commits 1 Branch 0 Tags 459 KiB
JavaScript 90.5%
Python 6.3%
HTML 3.2%
Go to file
Elizabeth Krumbach Joseph 61cda4a2e3 Add link to JSON file on index.html 
A json file is generated for each service, link this to the main page
so it's discoverable.

Change-Id: I4dc17671cb1d96eb8cbfef1aaf4604d8cfa34cc0
 		2014-03-28 12:52:39 -07:00
output/js Initial import 2012-12-21 16:08:08 +01:00
templates Add link to JSON file on index.html 2014-03-28 12:52:39 -07:00
.gitignore Add tox.ini, setup.py and do syntax cleanup 2014-03-11 16:13:25 -07:00
.gitreview Add tox.ini, setup.py and do syntax cleanup 2014-03-11 16:13:25 -07:00
LICENSE Initial import 2012-12-21 16:08:08 +01:00
README.rst Optionally rotate old data 2013-03-21 17:05:08 +01:00
bugdaystats.py Add tox.ini, setup.py and do syntax cleanup 2014-03-11 16:13:25 -07:00
config.js.sample Optionally rotate old data 2013-03-21 17:05:08 +01:00
setup.py Add tox.ini, setup.py and do syntax cleanup 2014-03-11 16:13:25 -07:00
tox.ini Add tox.ini, setup.py and do syntax cleanup 2014-03-11 16:13:25 -07:00

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.

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.