= Scrum Burndown in Trac =

== Description ==

A plugin to enable burndown chart capabilities, a common part of Scrum and other agile development methodologies.

== Installation Instructions ==

Installing this plugin is a four-step process.
 1. Apply this patch to enable the 'integer' ticket field type
 1. Add custom ticket fields
 1. Install the egg
 1. Create a cron/pycron job to run a daily python script

=== Add custom ticket fields ===
Add the following to your trac.ini file:

{{{
[components]
burndown.* = enabled

[ticket-custom]
orig_estimate = integer
orig_estimate.label = Original Estimate (in hours)
current_estimate = integer
current_estimate.label = Current Estimate (in hours)
time_spent = integer
time_spent.label = Time Spent
}}}

Original estimate is not really used by the plugin, it's just common Scrum process to be able to see how the estimates have change throughout a given sprint.

=== Installing the egg ===
Install just like you would any other Trac plugin.  Drop the egg into your plugins or site-packages folder and then try to access Trac in your browser.  You will get an error message saying that the database needs to be upgraded and telling you the trac-admin command to do it.  (I think it's something like 'trac-admin !YourProjectName.db upgrade').  Perform the upgrade.

=== Pycron/cron job ===
Download the this file: attachment:burndown_job.py and place it into a directory where you can run it with python.  For example, C:\Python23\Scripts\

Set up a job to run the burndown_job.py script once a day.  I personally am using Windows, so I used pycron.  Here is an example pycron tab file to run the job at noon on weekdays: attachment:crontab.txt  

This job totals up all the remaining time for given milestones and components and saves the information into the trac burndown table so that the plugin can use it to draw charts.

== Using the plugin ==

More coming here soon...

== Bugs/Feature Requests == 

Existing bugs and feature requests for ScrumBurndownPlugin are 
[report:9?COMPONENT=ScrumBurndownPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=ScrumBurndownPlugin&owner=sambloomquist new ticket].

== Download ==

Download the zipped source from [download:scrumburndownplugin here].

Download the distributable Python egg from [attachment:TracBurndown-0.1-py2.3.egg here].

== Source ==

You can check out ScrumBurndownPlugin from [http://trac-hacks.org/svn/scrumburndownplugin here] using Subversion, or [source:scrumburndownplugin browse the source] with Trac.

== Recent Changes ==

[[ChangeLog(scrumburndownplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:sambloomquist] [[BR]]
'''Contributors:'''