openstack
/
bugdaystats
Code Issues Proposed changes
Tool to produce static HTML that shows progress during a Bug Day
14 Commits 1 Branch 0 Tags 464 KiB
JavaScript 90.5%
Python 6.3%
HTML 3.2%
Go to file
Sean McGinnis b0dad97c33
Fix pep8 tox environment 
Changes to tox and the pep8 package require updates to the tox
environment definition.

Change-Id: Id95ae5fe17f71e15903e646f3065db85282359ba
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
 		2021-07-26 13:35:24 -05:00
output/js Initial import 2012-12-21 16:08:08 +01:00
templates Prettified all HTML files 2014-06-08 19:16:27 +02:00
.gitignore Add .tox dir to .gitignore 2016-09-19 11:14:05 +02: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 Add "daily" option to bugdaystats.py 2016-09-20 12:35:53 +02:00
bugdaystats.py Fix pep8 tox environment 2021-07-26 13:35:24 -05:00
config.js.sample Add "daily" option to bugdaystats.py 2016-09-20 12:35:53 +02:00
setup.py Fix pep8 tox environment 2021-07-26 13:35:24 -05:00
test-requirements.txt Fix pep8 tox environment 2021-07-26 13:35:24 -05:00
tox.ini Fix pep8 tox environment 2021-07-26 13:35:24 -05: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. 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.