captainhook 0.5

What is it

If installed, this package will install a pre-commit hook for git into the git repository that you are in at the time of installation.

Upon committing code, the pre-commit hook runs checks against the python files to be committed and rejects the commit if any of the checks fail.

Installation

Install using pip:

pip install captainhook

Once installed into your environment, you will be able to run:

captainhook

from within any git repo, and the pre-commit hook will be installed.

Setting Up

By default, all hooks are on. To turn off a hook, create a tox.ini file in the base directory of your project with a captainhook section.

eg:

[captainhook]
flake8=off
pdb=off

Checks

Currently supported checks are

• pdb: Checks to see if there are any uncommented import pdb; pdb.set_trace() statements in the code to be committed.

• flake8: Runs flake8 against the files that are set to be committed.

• python3: Checks to see if python files set to be committed are python3 compatible.

Output

You only see output for checks that fail, otherwise silence.

Example output upon a rejected commit:

===============================================================================
Checking python3
===============================================================================
  File "captainhook/pre_commit.py", line 77
    print 'a'
            ^
SyntaxError: invalid syntax
===============================================================================
Checking flake8
===============================================================================
pre-commit.py:19:1: F401 'importlib' imported but unused
pre-commit.py:128:1: E302 expected 2 blank lines, found 1
setup.py:25:80: E501 line too long (89 > 79 characters)
===============================================================================
Rejecting commit
===============================================================================

Developing

Running pre-commit.py on its own will by default cause a git stash to take place which you probably don’t want when testing a new check.

You can run the script without performing such a stash using:

python pre-commit.py -n