wiki:TracHoursPlugin

Version 31 (modified by k0s, 5 years ago) (diff)

--

track hours spent on tickets

Goals of TracHoursPlugin

The goal of this plugin is to help keep track of hours worked on tickets. TracHoursPlugin is an alternative TimingAndEstimationPlugin, but with a different approach:

  • instead of adding hours only via ticket fields, there is a separate view for managing ticket hours. /hours/<ticket number> displays the accrued hours for a particular ticket with a timeline-like view, but should also allow adding of new hours (by default, on "today", but this should be changeable via dropdown menus for day, month, year, etc), editing previously entered hours (amount, date, description) and deleting previously alloted hours if you have the appropriate permissions (TICKET_ADD_HOURS for your own hours, TRAC_ADMIN for the hours of others).
  • a management and query view is at /hours. This view displays the hours for all tickets for a given time period (last week, by default) in a way that combines the query interface for querying tickets and the timeline display for hours on the tickets in the time period. Query filters are available to find hours for people, hours for tickets of a certain component, etc.
  • hours are uniquely assigned to tickets and people
  • hours may have a description, which should be displayed in the applicable views; if a description is provided, the hours and description are logged to ticket comments
  • Tickets have links to /hours/<ticket number> as the total hours field so that a user can add and view hours for the ticket

Hour tracking and estimation is most useful when the following questions can be answered:

  • How much time has been spent on a project?
  • How much time remains in a budget (estimate for a project)?
  • How much time have we committed to for the next time period ?
  • How much time is a developer committed to over the next time period?

If we put hour estimates on tickets, assign tickets to people, associate tickets with milestones, and give milestones due dates, TracHours can generate reports to answer those questions.

For other trac time-tracking solutions, see http://trac.edgewall.org/wiki/TimeTracking

Components

TracHours consists of a number of components that work together to help track your time:

TracHoursPlugin

TracHoursPlugin is the core component of TracHours.

  • API function
  • Navigation bar provider
  • Query view for /hours
  • Ticket hours view for /hours/<ticket number>
  • Stream filter for checking and rendering of estimated hours and total hours fields for tickets
  • RSS feeds at /hours?format=rss and /hours/<ticket number>?format=rss

This component must be enabled to use any functionality from the TracHoursPlugin

SetupTracHours

SetupTracHours sets up the database and custom fields for the TracHoursPlugin. You must enable this component for anything to work, including the TracHoursPlugin component.

TracHoursRoadmapFilter

TracHoursRoadmapFilter adds hours information for milestones at /roadmap and /milestone/<milestone name>

TracHoursSidebarProvider

The TracHoursSidebarProvider component uses the TicketSidebarProviderPlugin (if enabled) to add a form to each ticket for direct addition of hours to the ticket. Hours will be logged as the authenticated user and comments will not be made.

TracHoursByComment

The TracHoursByComment component enables adding hours by ticket comments. Comments containing snippets like 5 hours, 1 hour, 3.7 hours, or 0:30 hours will be added to the total hours for the ticket, if the commenter has the TICKET_ADD_HOURS permission.

MultiprojectHours

The TracHoursPlugin exports RSS from the /hours handler. This has been utilized in consumption to provide hours reports across projects sharing the same parent directory. If trachours.multiproject is enabled, then /hours/multiproject will become a handler front-ending hours reports throughout the project and a link to this will appear on the /hours page to /hours/multiproject.

The multiproject report breaks down hours by project and worker giving row and column totals. If there are no hours for a project then that project will not be shown.

screenshot for of the /hours/multiproject  page for two projects and one worker (k0s)

How to Use TracHours

The TracHoursHowto offers a guide of the features of the TracHoursPlugin and how to use them.

Installing and Enabling TracHours

TracHoursPlugin is enabled like any other trac plugin:

  • enable the plugin. Use either the webadmin interface or add the following lines to the trac.ini file:
[components]
trachours.* = enabled
  • add give users the permission TICKET_ADD_HOURS
  • you will need to run trac-admin <env> upgrade in order to create the correct database tables

Note: The TracHoursPlugin requires python at least 2.4

The TracHoursPlugin also requires the ComponentDependencyPlugin and the TicketSidebarPlugin to be installed and enabled in order to work properly.

Download the zipped source, check out using Subversion, or browse the source with Trac.

See also the trac plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin

Bugs/Feature Requests

Existing bugs and feature requests for TracHoursPlugin are here. If you have any issues, create a new ticket.

Recent Changes

[14042] by rjollos on 2014-07-26 20:10:15

Tidy up codebase.

  • Fixed indentation in templates.
  • Removed obsolete Trac API method comments.
  • Organized imports.
  • Fixed compatibility with Trac 1.1.2 in which db parameters have been removed from methods.
  • Removed use of macros.html (removed in Trac 1.1.2).
[13658] by rjollos on 2014-02-13 07:52:07
Fixed-up indentation and trimmed whitespace using reindent.py.
[13599] by rjollos on 2014-01-21 06:30:13
0.6dev: Fixed regression in [9707]. The Save query button was not functional. Fixes #11285, Refs #8517.

Author/Contributors

Original developed at The Open Planning Project

Authors: novalis, k0s

Attachments (4)

Download all attachments as: .zip