Overview / Installation

Therapist is a tool to help create robust, easily-configurable pre-commit hooks for Git. This allows you to find and fix common issues before you actually commit code to your repo.


Installing Therapist

Installing Therapist is easily done using pip. Assuming it is installed just run the following from the command line:

$ pip install therapist

This command will download the latest version of Therapist from the Python Package Index and install it to your system. More information about pip and pypi can be found here:

Alternatively you can install from the distribution using the setup.py script:

$ python setup.py install

You could also install the development version by running the following:

$ pip install therapist==dev

Or simple install from a clone of the git repo:

$ git clone https://github.com/rehandalal/therapist.git
$ mkvirtualenv therapist
$ pip install -r requirements.txt
$ pip install --editable .


The first thing you should do is to install the git pre-commit hook. You can do this by running:

$ therapist install

Now all you need to do is create a configuration as outlined in the Configuration section.


If you decide you no longer want to use the Therapist pre-commit hook, simply run:

$ therapist uninstall


This will remove any pre-commit hook that is installed. It does not check to verify that it is the Therapist pre-commit hook.