doc/gitstats-stats.txt

   1 syntax: stats.py <sub-command> <arguments>
   2
   3 Available commands:
   4   author  Activity for one author, file, or project
   5   branch  In how far a commit belongs to a branch
   6   bug     Determine whether a commits a bugfix
   7   commit  Basic functionality already present in git
   8   diff    Compare two diffs and find reverts
   9   index   Find which commits touched the staged files
  10   matcher Try to match hunks in a diff to find moves
  11   test    Run the unittests for GitStats
  12
  13 The stats.py module is the main entry point of GitStats,
  14 it dispatches to the commands listed above. When no
  15 arguments are passed, it automatically runs the command
  16 with '--help' so that a usage message is shown for that
  17 command.
  18
  19 Each of the modules it uses as sub-commands defines a
  20 'dispatch' function that is called with the users arguments
  21 (with the exception of the first, which is the name of the
  22 command executed). If anything should be returned to the
  23 system, the dispatch method should return this value.
  24
  25 To run properly it requires the git_stats package to be
  26 a sub-directory of the directory it resides in. That is,
  27 your directory tree should be something like this:
  28 .
  29 |-- git_stats
  30 |   `-- <listing of all installed modules>
  31 |-- scripts
  32 |   `-- <listing of all installed scripts>
  33 |-- t
  34 |   `-- <listing of all installed regression tests>
  35 `-- stats.py
  36