https://github.com/kxxoling/pep8-git-hook
A customised PEP8 git hook
https://github.com/kxxoling/pep8-git-hook
Last synced: 6 months ago
JSON representation
A customised PEP8 git hook
- Host: GitHub
- URL: https://github.com/kxxoling/pep8-git-hook
- Owner: kxxoling
- Created: 2015-04-13T07:03:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-04-13T07:18:02.000Z (over 10 years ago)
- Last Synced: 2025-02-05T08:13:37.879Z (8 months ago)
- Language: Python
- Size: 102 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PEP8 Git Commit Hook
====================
This is a pre-commit hook for Git that checks the code to be committed
for Python PEP8 style compliance. The hook will prevent the commit in
case style violations are detected.
## Installation
1. Install the pep8 program: ``pip install pep8``
2. Save pre-commit as ``your_project/.git/hooks/pre-commit``
3. Mark pre-commit executable: ``chmod +x your_project/.git/hooks/pre-commit``
## Configuration
The hook can be overridden: ``$ git commit --no-verify``
Currently, the following PEP8 codes are checked for:
* E111 indentation is not a multiple of four
* E125 continuation line does not distinguish itself from next logical line
* E203 whitespace before ':'
* E261 at least two spaces before inline comment
* E262 inline comment should start with '# '
* E301 expected 1 blank line, found 0
* E302 expected 2 blank lines, found 1
* E303 too many blank lines (2)
* E502 the backslash is redundant between brackets
* E701 multiple statements on one line (colon)
* E711 comparison to None should be ``if cond is None:``
* W291 trailing whitespace
* W293 blank line contains whitespace
All error codes can be found [here](http://pep8.readthedocs.org/en/latest/intro.html#error-codes),
everything can be chosen by yourself.
In case you want to modify the list of codes to ignore, edit the
``ignore_codes`` list in the pre-commit file.
If you want to select only specific codes to scan for, use the
``select_codes`` list.
This code was original from [https://gist.github.com/810399](https://gist.github.com/810399),
forked from [https://github.com/cbrueffer/pep8-git-hook](https://github.com/cbrueffer/pep8-git-hook).