INSTALL

   1 GitStats makes use of the git-python git wrapper for
   2 python. It may be downloaded at [0]. Another option is to
   3 get it from pypi at [1]. Installation instructions may be
   4 found in the README of git-python. Since git-python is in
   5 development, changes made to git-python could break
   6 GitStats. As such, it is recommended to use the latest
   7 tested tag of git-python. Currently this is tag 0.1.4.
   8
   9 GitStats requires that git is installed, (it is recommended
  10 that the most recent release of git is used, although
  11 everything should work with older version too). For ease of
  12 use the 'stats.py' module should be in your PATH. That is,
  13 it should be possible to execute stats.py when your current
  14 working directory does not contain it. When that is the
  15 case one can use stats.py while in a git repository, and
  16 thus gather metrics on _that_ repository, instead of on the
  17 GitStats repository. The modules in the git_stats package
  18 themselves do not have to be in your PATH though, as long
  19 as they are reachable by stats.py.
  20
  21 To use GitStats simply invoke stats.py from the repository
  22 you want to gather statistics on. GitStats is split up
  23 into several sub-commands, see the documentation of each
  24 of these sub-commands for a more thorough explantation. As
  25 such, the command you should use is 'stats.py <cmd>', where
  26 '<cmd>' is one of the sub-commands. For example, to gather
  27 statistics about authors, use 'stats.py author <args>'. The
  28 documentation of the 'author' module explains which
  29 arguments it understands, and what they mean.
  30
  31 [0] http://gitorious.org/projects/git-python
  32 [1] http://pypi.python.org/pypi/GitPython/
  33