wiki:TimingAndEstimationPlugin

Version 71 (modified by bobbysmith007, 7 years ago) (diff)

--

Timing and Estimation Plugin

Demo Site | User Manual | Open Tickets | new ticket

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 compatible with Trac >= .10

Supported Versions

Currently this has been tested on Python >=2.4 (it will not run on 2.3 because I am using generator expressions in a few places). and Trac .10dev with sqlite >= 3.2.3 backend. This plugin should also support mysql and postgresql DB backends.

  • Genshi is supported in the Trac 0.11 branch of this plugin. However, you must upgrade to genshi head (instead of the version trac11 installs by default).
  • Clearsilver is a requirement for running the Trac 0.10 version of this plugin .
  • Because we are using ITicketChangeListener this plugin is only compatable with Trac >= .10

Getting the Plugin

Download the source using Svn at:

Download the zipped source :

When downloading these files the extention is lost, or the filename corrupted. 
  a simple rename to filename.zip seems to resolve it the contents are intact

Browse the source using Trac:

In the repository there is a script folder 0.10/0.11 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)

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. Be sure that the plugin is enabled. Add "timingandestimationplugin.* = enabled" to trac.ini (in the [components] subheading).
    • Alternatively, this can be enabled in the Web Admin section of the website as well
  3. 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.
      
  4. Reload/restart your HTTPD / other webserver / Tracd. That's it.

Post Installation Configuration Options

Components

By default, the TimingAndEstimationPlugin'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

Permissions (Trac 11 only)

  • #2667 - Has a full scheme for enforcing permission on viewing time tracking and estimation data. It currently requires the use of another plugin to accomplish everything it does, but I am looking for a way to integrate this.

Post Commit Hook

Bugs/Feature Requests

Existing bugs and feature requests for TimingAndEstimationPlugin are here.

If you have any issues, create a new ticket.

Uninstall Help

There is not a lot here, but ticket:995 is the best source of information for people uninstalling the plugin.

Related Plugins

Interacting with T&E

If you want a plugin that you are writing to add reports to the management page, there is a file, reportmanager.py, that should make interacting with its reports easier.

Recent Changes

Full Change Log

[14062] by bobbysmith007 on 2014-08-04 15:13:24
Updated csv export permissions monkey patch for trac 1.0 re #11898
[14061] by bobbysmith007 on 2014-08-04 15:04:36
branched for trac1.0
[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

Author/Contributors

Author: bobbysmith007
Contributors:

  • Alessio Massaro
    • trac-hacks wiki:masariello
    • Helped Get Reports working in postgres and started moving toward generic work rather than hours
  • kkurzweil@…
    • helped postegresql db backend compatiblity
  • Jonas Borgstrom : http://trac.edgewall.org/wiki/JonasBorgstrom
    • made it so that base_url was unnecessary
  • Colin Guthrie
    • Refactored custom reports stuff into a single class/module that can be copied to other plugins, to make interaction with T&E easier.
  • David Abrahams
    • Trac.11 - Stream filters to prettify the Reports Screen and make TotalHours not editable