wiki:TimingAndEstimationPlugin

Version 23 (modified by anonymous, 8 years ago) (diff)

Hopefully improved install details for n00bs, and started documenting details on plugin components.

Timing and Estimation Plugin

To see it in action Head This Way!

Description

This is a plugin that adds (aspires to add) estimation and time tracking to Trac.

This basically adds CustomFields and CustomReports and an interface for filling the dynamic variables for the report. (requires javascript).

Because we are using ITicketChangeListener this plugin is only compatable with Trac >= .10

Documents

Installation Help

  1. Install the plugin (either for a single project, or globally). See the details on how to install a trac plugin at: TracPlugins
  2. Run $ trac-admin /path/to/projenv upgrade
    • You should get a message like this:
      Timing and Estimation needs an upgrade
      Upgrading Database
      Creating bill_date table
      Creating report_version table
      Upgrading fields
      Upgrading reports
      Upgrading usermanual
      Done Upgrading
      Upgrade done.
      
  3. Reload/restart your HTTPD / WebServer / Tracd. That's it.

Post Installation Configuration Options

By default, the TimingAndEstimation plugin's four components will all be active. However, you can disable some of the components if you want to. (The easiest way to do this is to ensure you have the trac:WebAdmin plugin installed.)

The plugin's components are:

  1. TimeTrackingSetupParticipant Required component.
  2. TimeTrackingTicketObserver Ensures that the "Total Hours" values are updated when a user edits a ticket's "Add Hours to Ticket" field. You would not normally want to disable this component.
  3. TicketWebUiAddon
  4. TimingEstimationAndBillingPage

Bugs/Feature Requests

Existing bugs and feature requests for TimingAndEstimationPlugin are here.

If you have any issues, create a new ticket.

Supported Versions

Currently this has been tested on Python 2.4 (I think it should run on 2.3 as well though) and Trac .10dev with sqlite >= 3.2.3 backend. We have been working on improving support for the postgres/mysql backends, but I dont currently have postgres to test on, so this is a user driven process.

Because we are using ITicketChangeListener this plugin is only compatable with Trac >= .10

Download

Download the zipped source from here.

Source

You can check out TimingAndEstimationPlugin from here using Subversion, or browse the source with Trac.

In the repository there is a scripts folder that contains some various python files that I have written to perform billing queries across an entire directory of tracs and email the results to a specified address. As is these are written to work in my setup and some paths at the top of each file will probably need to be changed. These are mostly included because I wrote them for myself and thought others might want to perform similar tasks. (See: script help)

Example

This basically adds CustomFields and CustomReports and an interface for filling the dynamic variables for the reports (requires javascript).

The goal of this plugin is to allow us to spec out projects (with estimates) and bill our clients based on the time records recorded.

Related Plugins

  • The ScrumBurndownPlugin makes use of this plugin to provide a javascripted daily burndown chart, useful in the agile development methodology known as Scrum.

Recent Changes

[13377] by bobbysmith007 on 2013-09-05 17:01:48
removed misleading sentence in the user manual
[12966] by bobbysmith007 on 2013-04-08 20:47:56
remove hours/work summary reports from the view-tickets screen re #11005
[12858] by bobbysmith007 on 2013-04-01 18:06:03
make add_hours_from_comment work in the face of ajax previews

Author/Contributors

Author: bobbysmith007
Contributors: