Automatically run pep8 on staged git content before committing to your repo.
This provides a git pre-commit hook that runs pep8 on staged git content. If pep8 fails, the content will not be committed to the repo. This enables fast turnaround to enforce code styles within your repository.
The hook runs on the staged content, not the current working copy.
Most of the code is taken from this post by Ben McCormick
When you try to commit a file with pep8 errors, git will bail before completing the commit.
script.py
def line (slope, y_interpect,x):
return slope*x+y_intercept
$ git add script.py
$ git commit
script.py:1:9 E211 whitespace before '('
script.py:1:29 E231 missing whitespace after ','
pep8 Failed: script.py
$
If you'd like to distribute the pre-commit hook with your repository:
- Copy these files into your repository and run
install-hooks.shscript. - Commit them to the repository so that it will be easy to share the script with other contributors.
To use the hook only, copy the git-hooks/pre-commit file into your
repository's .git/hooks directory.
See the pep8 documentation.
The easiest way to distribute a code style for a repository is to commit a pep8
section to setup.cfg.
Example:
[pep8]
max-line-length=100
exclude=migrations/*