[[PageOutline(2-5,Contents,pullout)]]

= Project progress statistics and quality metrics

== Description

TracMetrixPlugin improves project visibility through a collection of software metrics and statistics. The scope of this plugin is to provide the most commonly used software quality metrics and progress statistics. It is designed to bridge the information gap between the software development team and management while reducing the tracking effort required by developers.

Please feel free to leave comments [wiki:TracMetrixPlugin/FeedBack here]. For more information, see:
 * [https://projects.cecs.pdx.edu/~bhuricha/SCOPE/index.cgi/wiki/TracMetrix TracMetrix Proposal]
 * [TracMetrixRequirements Requirements]

See also TicketChartsMacro, TracTicketStatsPlugin, TicketStatsMacro.

== Bugs/Feature Requests

Existing bugs and feature requests for TracMetrixPlugin are 
[report:9?COMPONENT=TracMetrixPlugin here].

If you have any issues, create a 
[/newticket?component=TracMetrixPlugin new ticket].

[[TicketQuery(component=TracMetrixPlugin&group=type,format=progress)]]

== Download

Download the latest revision from [download:tracmetrixplugin here].

== Source

You can check out TracMetrixPlugin from [http://trac-hacks.org/svn/tracmetrixplugin here] using Subversion, or [source:tracmetrixplugin browse the source] with Trac.

== Installation

Dependencies:
 * Python 2.4 or greater
 * Trac 0.11.6 or greater
 * [http://matplotlib.sourceforge.net/ MatPlotLib] 0.87.7 or above
 * [http://numpy.scipy.org/ Numpy] 1.0.1 or above
 * python-tk

The plugin works on both Windows and Linux environments.

 1. Install the plugin either for a single project, or globally. See the details on how to install a Trac plugin at [trac:TracPlugins].
 1. Enable the plugin by adding the following in your `trac.ini` file under the [components] subheading.
{{{#!ini
[components]
tracmetrixplugin.* = enabled
}}}
  * Alternatively, this plugin can be enabled in the plugin page in the Admin menu.
 1. Run `trac-admin /path/to/projenv upgrade`.
  * You should get a message like this:
{{{
TracMetrix Plugin needs an upgrade
creating cache folder
Done Upgrading
Upgrade done.
}}}
 1. Reload/restart your HTTPD / other webserver / Tracd.
   * If you get a very colourful stack trace saying "'module' object has no attribute 'cbook'", you forgot this step!
 1. The following options can be configured in `trac.ini`, where default values are shown:
{{{#!ini
[pdashboard]]
yui_base_url = http://yui.yahooapis.com/2.7.0    #Location of YUI API
}}}

== Example

[[Image(TracMetrixPlugin/Screenshots:backlogchart.png)]]

Visit TracMetrixPlugin/Screenshots for more screen shots.

== Recent Changes

[[ChangeLog(tracmetrixplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:khundeen] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' [wiki:jnatividad] [[BR]]