openstack/bugdaystats
Code Issues Proposed changes
Tool to produce static HTML that shows progress during a Bug Day
20 Commits 1 Branch 0 Tags 464 KiB
JavaScript 90.5%
Python 6.3%
HTML 3.2%
master
Go to file
Sean McGinnis b207744a7b
Update for py3 support 
This updates the default jobs and various settings to reflect py3
support. Updates to the README also due to switching to use a
requirements.txt file.

Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Change-Id: I19ae0818e166e1b801797a6d50ec4aa8cb0c3300
2021-07-26 14:53:50 -05:00
output/js Introduce daily bug stats chart 2021-07-26 14:06:14 -05:00
templates Introduce daily bug stats chart 2021-07-26 14:06:14 -05:00
.gitignore Add .tox dir to .gitignore 2016-09-19 11:14:05 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:48 +00:00
bugdaystats.py Update for py3 support 2021-07-26 14:53:50 -05:00
config.js.sample Add "daily" option to bugdaystats.py 2016-09-20 12:35:53 +02:00
LICENSE Initial import 2012-12-21 16:08:08 +01:00
README.rst Update for py3 support 2021-07-26 14:53:50 -05:00
requirements.txt Update for py3 support 2021-07-26 14:53:50 -05:00
setup.cfg Update for py3 support 2021-07-26 14:53:50 -05:00
setup.py Update for py3 support 2021-07-26 14:53:50 -05:00
test-requirements.txt Fix pep8 tox environment 2021-07-26 13:35:24 -05:00
tox.ini Update for py3 support 2021-07-26 14:53:50 -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.

Usage

python3 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. An example config.js.sample file is provided that may be renamed and modified to suite your needs.

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.