|Version 45 (modified by rjollos, 6 years ago) (diff)|
TracHoursPlugin - Track hours spent on tickets
Table of Contents
Known (Confirmed) Issues
- Incompatible with iCalExporterPlugin (#4368)
- Filters cannot be removed from the Hours page in Trac 0.12 (#7642)
- WorkLogPlugin does not work with TracHoursPlugin (#7503)
- Hours entry will be inline with the ticket template rather than in the sidebar (#8264)
- Organizing and improving the queries / reports (#8280)
- 05-Dec-2010: Repository has been reorganized. The stable versions can now be found at ^/trachoursplugin/branches/0.11 and ^/trachoursplugin/branches/0.12. Development occurs on ^/trachoursplugin/trunk.
- 04-Dec-2010: Maintainership handed over from ejucovy, k0s to rjollos. Plugin will be actively developed in the coming months.
Goals of TracHoursPlugin
- 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 t:TimeTracking.
TracHours consists of a number of components that work together to help track your time:
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 sets up the database and custom fields for the TracHoursPlugin. You must enable this component for anything to work, including the TracHoursPlugin component.
TracHoursRoadmapFilter adds hours information for milestones at /roadmap and /milestone/<milestone name>
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.
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.
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.
How to Use TracHours
Installing and Enabling TracHours
TracHoursPlugin requires the following components:
- DateUtil, avalaible here or package python-dateutil on Debian based systems.
- FeedParser, avalaible here or package python-feedparser on Debian based systems.
Now, TracHoursPlugin is enabled like any other trac plugin:
- Download and install the plugin.
- Enable the plugin. Use either the webadmin interface or add the following lines to the trac.ini file:
[components] trachours.* = enabled
- You will need to upgrade trac-admin <env> upgrade in order to create the correct database tables.
- Add give users the permission TICKET_ADD_HOURS
Note: The TracHoursPlugin requires python at least 2.4
- 16030 by rjollos on 2016-11-29 23:39:16
0.6.0dev: Adapt to Trac 1.0 database API
- 16029 by rjollos on 2016-11-29 22:33:59
0.6.0dev: Require Trac >= 1.0
- 15264 by rjollos on 2016-02-11 05:22:34
Remove unnecessary svn:mime-type on py files
svn:mime-type was set to "plain" for many files.
Original developed at The Open Planning Project