Skip to main content

Pylint wrapper that verifies code reaches a minimum quality score.

Project description

https://gitlab.com/TNThieding/pylint-fail-under/badges/master/pipeline.svg https://gitlab.com/TNThieding/pylint-fail-under/badges/master/coverage.svg Documentation Status

Pylint wrapper that verifies code reaches a minimum quality score.

Quick Start

Execute the pylint-fail-under command with the same arguments as a pylint call. In addition, specify the minimum Pylint quality score with the --fail_under argument.

If the Pylint score is greater than the fail under value, the script exits successfully with an exit code of zero. For example:

$ pylint-fail-under --fail_under 9.0 my_package
************* Module my_package
my_package\__init__.py:1:0: C0111: Missing module docstring (missing-docstring)
### Pylint output removed for documentation conciseness! ###
my_package\tests\test_my_pkg.py:328:0: C0303: Trailing whitespace (trailing-whitespace)

------------------------------------------------------------------
Your code has been rated at 9.49/10 (previous run: 9.49/10, +0.00)

Otherwise, if the Pylint score is under the minimum, the script exits with a non-zero exit code. For example:

$ pylint-fail-under --fail_under 9.75 my_package
************* Module my_package
my_package\__init__.py:1:0: C0111: Missing module docstring (missing-docstring)
### Pylint output removed for documentation conciseness! ###
my_package\tests\test_my_pkg.py:328:0: C0303: Trailing whitespace (trailing-whitespace)

------------------------------------------------------------------
Your code has been rated at 9.49/10 (previous run: 9.49/10, +0.00)

ERROR: score 9.4921875 is less than fail-under value 9.75

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylint-fail-under, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pylint_fail_under-0.3.0-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pylint-fail-under-0.3.0.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page