Changes between Version 39 and Version 40 of TracHoursPlugin
- Timestamp:
- Aug 31, 2010, 10:21:30 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracHoursPlugin
v39 v40 1 = track hours spent on tickets =1 = TracHoursPlugin - Track hours spent on tickets = 2 2 3 3 [[TOC]] … … 5 5 == Goals of TracHoursPlugin == 6 6 7 The goal of this plugin is to help keep track of hours worked on 8 tickets. TracHoursPlugin is an alternative 9 [http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin], but with a different approach: 7 The goal of this plugin is to help keep track of hours worked on tickets. TracHoursPlugin is an alternative to [http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin], but with a different approach: 10 8 11 * 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).12 * 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.13 * hours are uniquely assigned to tickets and people14 * 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 comments15 * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket 9 * 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). 10 * 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. 11 * Hours are uniquely assigned to tickets and people. 12 * 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. 13 * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket. 16 14 17 15 Hour tracking and estimation is most useful when the following questions can be answered: … … 22 20 * How much time is a developer committed to over the next time period? 23 21 24 If we put hour estimates on tickets, assign tickets to people, associate 25 tickets with milestones, and give milestones due dates, !TracHours can generate reports to answer those questions. 22 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. 26 23 27 For other trac time-tracking solutions, see 28 http://trac.edgewall.org/wiki/TimeTracking 24 For other Trac time-tracking solutions, see http://trac.edgewall.org/wiki/TimeTracking 29 25 30 26 == Components == … … 35 31 36 32 `TracHoursPlugin` is the core component of !TracHours. 37 * API function 38 * Navigation bar provider 39 * Query view for `/hours` 33 34 * API function. 35 * Navigation bar provider. 36 * Query view for `/hours`. 40 37 * Ticket hours view for `/hours/<ticket number>` 41 38 * Stream filter for checking and rendering of estimated hours and total hours fields for tickets … … 64 61 === [source:trachoursplugin/0.11/trachours/multiproject.py MultiprojectHours] === 65 62 66 The TracHoursPlugin exports RSS from the `/hours` handler. This has 67 been utilized in consumption to provide hours reports across projects 68 sharing the same parent directory. If `trachours.multiproject` is 69 enabled, then `/hours/multiproject` will become a handler front-ending 70 hours reports throughout the project and a link to this will appear on 71 the `/hours` page to `/hours/multiproject`. 63 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`. 72 64 73 The multiproject report breaks down hours by project and worker giving 74 row and column totals. If there are no hours for a project then that 75 project will not be shown. 65 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. 76 66 77 67 [[Image(multiprojecthours.png, border=1)]] … … 81 71 The TracHoursHowto offers a guide to the features of the TracHoursPlugin and how to use them. 82 72 83 84 73 == Installing and Enabling !TracHours == 85 74 86 ''NEW & HANDY!!''[[BR]] 87 '''Updated Missing Module and modifed setup file''' 75 TracHoursPlugin requires the following components: 88 76 89 * !FeederParser[http://code.google.com/p/feedparser/downloads/list] ,available as attachment 90 * !DateUtil[http://pypi.python.org/pypi/python-dateutil/1.4.1] ,request you to download from the net and create .egg 91 * TracSQLHelper ,available as attachment 92 * TracHoursPlugin(modified) ,available as attachment 93 Please install the plugins either the WebAdmin Way or the Trac.ini way [[BR]] 94 Once the Plugin is installed you need to upgrade your database and restart you server [[BR]] 77 * ComponentDependencyPlugin 78 * TicketSidebarProviderPlugin 79 * TracSqlHelperScript 95 80 81 You need to install them before installing TracHoursPlugin. See [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin InstallingaTracPlugin] for more information on installing plugins. Additionally, you will require on your server: 96 82 97 98 {{{ 83 * !DateUtil, avalaible [http://pypi.python.org/pypi/python-dateutil/1.4.1 here] or package ''python-dateutil'' on Debian based systems. 84 * !FeedParser, avalaible [http://code.google.com/p/feedparser/downloads/list here] or package ''python-feedparser'' on Debian based systems. 99 85 100 }}} 101 TracHoursPlugin is enabled like any other trac plugin: 86 Now, TracHoursPlugin is enabled like any other trac plugin: 102 87 103 * download and install the plugin; see plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin 88 Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac. 104 89 105 * enable the plugin. Use either the webadmin interface or add the following lines to the {{{trac.ini}}} file:106 90 * Download and install the plugin. 91 * Enable the plugin. Use either the webadmin interface or add the following lines to the {{{trac.ini}}} file: 107 92 {{{ 108 93 [components] 109 94 trachours.* = enabled 110 95 }}} 111 112 * add give users the permission `TICKET_ADD_HOURS` 113 114 * you will need to run {{{trac-admin <env> upgrade}}} in order to create the correct database tables 96 * You will need to upgrade {{{trac-admin <env> upgrade}}} in order to create the correct database tables. 97 * Add give users the permission `TICKET_ADD_HOURS` 115 98 116 99 '''Note:''' The TracHoursPlugin requires python at least 2.4 117 118 The TracHoursPlugin also requires the ComponentDependencyPlugin and the TicketSidebarProviderPlugin to be installed and enabled in order to work properly. (They may be enabled via the "Plugins" menu in the trac administration page.)119 120 Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac.121 122 See also the trac plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin123 124 100 125 101 == Bugs/Feature Requests == 126 102 127 103 Existing bugs and feature requests for TracHoursPlugin are [query:status!=closed&component=TracHoursPlugin&order=priority here]. 128 If you have any issues, create a 129 [/newticket?component=TracHoursPlugin&owner=k0s new ticket]. 130 104 If you have any issues, create a [/newticket?component=TracHoursPlugin&owner=k0s new ticket]. 131 105 132 106 == Recent Changes ==