Skip to main content

Git commit hook that checks Python files with pylint

Project description

<a href=’https://travis-ci.org/sebdah/git-pylint-commit-hook’><img src=’https://secure.travis-ci.org/sebdah/git-pylint-commit-hook.png?branch=master’></a>

Pre-commit hook for Git checking Python code quality. The hook will check files ending with .py or that has a she bang (#!) containing python.

By default the script looks in the root directory of your project for a .pylintrc file, which it passes to pylint. It also looks for a [pre-commit-hook] section for options of it’s own.

Installation

Install via PyPI

pip install git-pylint-commit-hook

Usage

The commit hook will automatically be called when you are running git commit. If you want to skip the tests for a certain commit, use the -n flag, git commit -n.

### Configuration

Settings are loaded by default from the .pylintrc file in the root of your repo.

[pre-commit-hook] command=custom_pylint params=–rcfile=/path/to/another/pylint.rc limit=8.0

_command_ is for the actual command, for instance if pylint is not installed globally, but is in a virtualenv inside the project itself.

_params_ lets you pass custom parameters to pylint

_limit_ is the lowest value which you want to allow for a pylint score. Any lower than this, and the script will fail and won’t commit.

Any of these can be bypassed directly in the pre-commit hook itself. You can also set a different default place to look for the pylintrc file.

Requirements

This commit hook is written in Python and has the following requirements:

Release notes

### 2.0.4 (2014-05-01)

### 2.0.3 (2014-02-07)

  • Fixed error in decimal representation

### 2.0.1 (2013-12-08)

### 2.0.0 (2013-12-08)

### 1.0.0 (2013-10-13)

  • Added support for default .pylintrc file, and also for loading our own options from there.

### 0.8 (2013-01-09)

### 0.7 (2012-12-07)

  • Bug when skipping __init__.py files fixed. Wrong path was checked under some circumstanses

### 0.6 (2012-12-04)

### 0.5 (2012-12-01)

### 0.4 (2012-11-30)

### 0.3 (2012-11-18)

  • Fixed bug with non-python files getting checked, if they contained python on the first row

### 0.2 (2012-11-16)

  • Added support for handling moved or deleted files

### 0.1 (2012-11-09)

  • Initial release of the commit hook

Project details


Release history Release notifications

History Node

2.4.0

History Node

2.3.0

History Node

2.2.2

History Node

2.2.1

History Node

2.2.0

History Node

2.1.1

History Node

2.1.0

History Node

2.0.9

History Node

2.0.8

History Node

2.0.7

History Node

2.0.6

History Node

2.0.5

This version
History Node

2.0.4

History Node

2.0.3

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0b

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
git-pylint-commit-hook-2.0.4.tar.gz (10.5 kB) Copy SHA256 hash SHA256 Source None May 1, 2014

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