Skip to main content

Help you find out what files you should be changing.

Project description

https://badge.fury.io/py/gitcoach.png https://travis-ci.org/tarmstrong/gitcoach.png?branch=master https://pypip.in/d/gitcoach/badge.png

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

Project details


Release history Release notifications

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
gitcoach-0.2.2.tar.gz (7.3 kB) Copy SHA256 hash SHA256 Source None Nov 10, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page