skip to navigation
skip to content

gitcoach 0.2.2

Help you find out what files you should be changing.

Gitlearn and gitcoach are a pair of tools for helping me, and hopefully other people, better understand large projects living in Git by trying to identify codependent pieces of code.

Installation

The easiest way to install gitcoach is through pip:

$ pip install gitcoach

Usage

To generate the prediction data, run gitlearn. This might take a long time:

usage: gitlearn [-h]

Generate coaching data for gitcoach.

optional arguments:
  -h, --help  show this help message and exit

The gitcoach utility:

usage: gitcoach [-h] [--file FILE] [--commit COMMIT] [--threshold THRESHOLD]

Find co-dependent files based on git history. Two files are co-dependent if
they have been modified in the same commits often enough.

optional arguments:
-h, --help            show this help message and exit
--file FILE, -f FILE  Find suggestions for a specific file
--commit COMMIT, -c COMMIT
                        Find suggestions for files modified in a specific
                        commit.
--threshold THRESHOLD, -t THRESHOLD
                        Threshold for co-incidence ratio (default=0.8).

Example output of gitcoach:

Here are some files you might want to look at:

travis.yml  suggested by    README.rst (0.500000)
tox.ini     suggested by    README.rst (0.500000)
setup.py    suggested by    README.rst (0.500000)
requirements.txt    suggested by    README.rst (0.500000)

History

0.1

  • Original version by mhoye

0.2.0 (2013-11-08)

  • Rewrite
  • New dependency: git2json
  • First version released on PyPI

0.2.2 (2013-11-09)

  • Python 3 compatibility
  • Packaging fixes
 
File Type Py Version Uploaded on Size
gitcoach-0.2.2.tar.gz (md5) Source 2013-11-10 7KB