Skip to main content

Run multiple python linters easily

Project description

multilint

https://img.shields.io/pypi/v/multilint.svg https://img.shields.io/travis/adamchainz/multilint.svg

Run multiple python linters easily.

Installation and Usage

Install with pip:

pip install multilint

Run with:

multilint

How It Works

I like to keep my projects tidy with a standard set of linters. Running them all turned out to be easier with a wrapper script, which I ended up copy-pasting between them all. This project stops me needing to copy/paste, centralizing running all these neat tools.

In order, it will check if these linters are installed, and if so, run them:

  • flake8, to check code quality

  • isort, in ‘diff’ mode to show where imports aren’t sorted

  • modernize, in ‘diff’ mode to show where python 2/3 compatibility with six is missing

  • python setup.py check, to check your setup.py is well configured. This will require docutils, and also Pygments if your long_description uses any code highlighting.

If any of them fail, multilint stops and dies with a non-zero exit code. Otherwise it succeeds!

You need to configure the paths that will be linted (by default, only setup.py is linted). Put a section in your setup.cfg like:

[tool:multilint]
paths = my_package
        tests
        setup.py

Usage With tox

I normally run my tests with tox. An example tox.ini to use multilint to do your linting on both Python 2.7 and 3.5 would look like:

[tox]
envlist =
    py{27,35},
    py{27,35}-codestyle

[testenv]
deps = -rrequirements.txt
commands = pytest

[testenv:py27-codestyle]
commands = multilint

[testenv:py35-codestyle]
commands = multilint

Then just put multilint, plus the linters you want it to run (e.g. flake8) in your requirements.txt.

History

Pending

  • New notes here

2.0.2 (2016-12-06)

  • Don’t invoke python setup.py check if there is no setup.py.

2.0.1 (2016-10-20)

  • Remove default for paths in setup.cfg.

  • Check that paths exist before running the linters.

2.0.0 (2016-09-24)

  • Use the config header tool:multilint in setup.cfg, rather than multilint, to avoid clashing with any potential setup.py commands. Your setup.cfg will need updating.

1.0.2 (2016-07-26)

  • Work with flake8 3.0+ which changed the way its main function worked.

1.0.1 (2016-07-16)

  • Fix modernize running on Python 2.

  • Run isort in the same Python process rather than with subprocess

  • Properly gate flake8 and isort so that they run only if they are installed.

1.0.0 (2016-06-19)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

multilint-2.0.2.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

multilint-2.0.2-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file multilint-2.0.2.tar.gz.

File metadata

  • Download URL: multilint-2.0.2.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for multilint-2.0.2.tar.gz
Algorithm Hash digest
SHA256 a0b0d21d50f2666baa41b0d056c16b6d343838f59f89cc0ff7b5cd5b1de25a89
MD5 58631daadfc23df8bdc08646d41e7192
BLAKE2b-256 81ef93679c39031206bc341c9d334e9b104130594b849e0be6751b18632d5d23

See more details on using hashes here.

Provenance

File details

Details for the file multilint-2.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for multilint-2.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9676194de81161e9878c02c7b4b06ba02e35d2d0ee6a25fc5f7bcee17c527f6d
MD5 4d9cfa514e19dbc17d40e5cf5a8a3acb
BLAKE2b-256 c0279b21be954eb465981e34a58263c0d6f8e3a5514044b0739f2001f6f64604

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page