Skip to content
Newer
Older
100644 95 lines (61 sloc) 2.26 KB
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
1 ===============
59a6684 @mrjbq7 Some cleanup to README.
mrjbq7 authored
2 TracStats
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
3 ===============
4
5
6 Description
7 ===========
8
59a6684 @mrjbq7 Some cleanup to README.
mrjbq7 authored
9 The TracStats project is a plugin for the 'trac' project management tool.
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
10
59a6684 @mrjbq7 Some cleanup to README.
mrjbq7 authored
11 The TracStats plugin adds a "Stats" tab to the trac project. Underneath this
3a6c130 @mrjbq7 Update readme.
mrjbq7 authored
12 tab can be found statistics about changesets, wiki pages, and tickets.
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
13
12298de @mrjbq7 More documentation.
mrjbq7 authored
14 Some features include:
15
16 * Recent activity (last 30 days) showing top 10 developers, projects, and paths
17 within the repository.
18
19 * Detailed statistics of source code development:
20
21 * Total files by time
22 * Commits by time, author, month, day of week, hour of day
23 * Recent commits
24 * Activity by time, author, project, filetype, change type
25 * Most active paths, files
26 * Commit cloud (built from checkin comments)
27
28 * Detailed statistics of Trac wiki pages:
29
30 * Total pages by time
31 * Edits by author
32 * Latest wiki pages changed
33 * Most active wiki pages
34 * Largest wiki pages
35
36 * Detailed statistics of Trac tickets:
37
38 * Open tickets by time
39 * Tickets by author, component
40 * Most active tickets
41 * Oldest open tickets
42 * Latest tickets reported, changed
43
44 * Drill down by author or path within the repository for more information.
45
59a6684 @mrjbq7 Some cleanup to README.
mrjbq7 authored
46 The TracStats plugin supports Trac installations with SQLite, MySQL, and
7b3f253 @mrjbq7 Adding support for PostgreSQL.
mrjbq7 authored
47 PostgreSQL database backends.
48
cb78eb2 @mrjbq7 Updating README with some notes for troubleshooting.
mrjbq7 authored
49 The TracStats plugin has been tested with Subversion, Mercurial, and Git
50 version control systems.
51
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
52
53 Installation
54 ============
55
59a6684 @mrjbq7 Some cleanup to README.
mrjbq7 authored
56 The TracStats plugin can be installed using standard::
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
57
88f720f @mrjbq7 Update README
mrjbq7 authored
58 $ easy_install tracstats
59
60 Or, grab the sources and build using::
61
62 $ python setup.py install
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
63
64
65 Configuration
66 =============
67
1aee05e @mrjbq7 Updating readme and setup.py.
mrjbq7 authored
68 It is configured in the ``trac.ini`` file by enabling and configuring::
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
69
eda41a6 @mrjbq7 Better ReST.
mrjbq7 authored
70 [components]
71 tracstats.* = enabled
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
72
1aee05e @mrjbq7 Updating readme and setup.py.
mrjbq7 authored
73 The ``STATS_VIEW`` permission is used to control access to the statistics pages.
db2a89c @mrjbq7 Initial version.
mrjbq7 authored
74
19762ae @mrjbq7 Adding a "project root" configurable parameter.
mrjbq7 authored
75 In addition, an optional "project root" within your repository can be
76 configured as the base for all projects and source code statistics::
77
78 [stats]
79 root = path/to/projects
80
cb78eb2 @mrjbq7 Updating README with some notes for troubleshooting.
mrjbq7 authored
81
82 Troubleshooting
83 ===============
84
85 If you use Git (i.e. the GitPlugin for Trac) and are not able to see any of
86 the code statistics, you likely need to configure it to cache the repository
1aee05e @mrjbq7 Updating readme and setup.py.
mrjbq7 authored
87 to make it work::
cb78eb2 @mrjbq7 Updating README with some notes for troubleshooting.
mrjbq7 authored
88
89 [git]
90 cached_repository = true
91 persistent_cache = true
92
66183b9 @mrjbq7 Update resync example. Fixes #31.
mrjbq7 authored
93 You might need to run ``trac-admin <project-env> repository resync
94 <reponame>`` after the change.
Something went wrong with that request. Please try again.