Skip to main content

Flake8 wrapper to make it nice and configurable

Project description

It’s a Flake8 wrapper to make it cool.

  • Sharable and remote configs.

  • Legacy-friendly: ability to get report only about new errors.

  • Use only specified plugins, not everything installed.

  • Manage codes per plugin.

  • Enable and disable plugins and codes by wildcard.

  • Make output beautiful.

  • pyproject.toml support.

  • Show codes for installed plugins.

  • Show all messages and codes for a plugin.

  • Check that all required plugins are installed.

  • Syntax highlighting in messages and code snippets.

  • PyLint integration.

output example

Installation

python3 -m pip install --user flakehell

Usage

First of all, let’s create pyproject.toml config:

[tool.flakehell]
# optionally inherit from remote config (or local if you want)
base = "https://raw.githubusercontent.com/life4/flakehell/master/pyproject.toml"
# specify any flake8 options. For example, exclude "example.py":
exclude = ["example.py"]
# make output nice
format = "grouped"
# 80 chars aren't enough in 21 century
max_line_length = 90
# show line of source code in output
show_source = true

# list of plugins and rules for them
[tool.flakehell.plugins]
# include everything in pyflakes except F401
pyflakes = ["+*", "-F401"]
# enable only codes from S100 to S199
flake8-bandit = ["-*", "+S1??"]
# enable everything that starts from `flake8-`
"flake8-*" = ["+*"]
# explicitly disable plugin
flake8-docstrings = ["-*"]

Show plugins that aren’t installed yet:

flakehell missed

Show installed plugins, used plugins, specified rules, codes prefixes:

flakehell plugins
plugins command output

Show codes and messages for a specific plugin:

flakehell codes pyflakes
codes command output

Run flake8 against the code:

flakehell lint

This command accepts all the same arguments as Flake8.

Read flakehell.readthedocs.io for more information.

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

flakehell-0.1.5.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

flakehell-0.1.5-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file flakehell-0.1.5.tar.gz.

File metadata

  • Download URL: flakehell-0.1.5.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.0

File hashes

Hashes for flakehell-0.1.5.tar.gz
Algorithm Hash digest
SHA256 e2b0f90a12ee6f83a5c0dda9a543a3ded83368737667d4075438be27f2b7a49c
MD5 4fbc831d8ac6779da1eda3ca919ddd2c
BLAKE2b-256 b623fba57e2516014b6ee049711cd2b933b6bac5467819540f5b059a58657e49

See more details on using hashes here.

File details

Details for the file flakehell-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: flakehell-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.0

File hashes

Hashes for flakehell-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 36a569b82dd0e8e6295dd7ff788da352b5bc7e4e6a254b8cfdb44309c4a5ca0e
MD5 3dc3d92f902860379b1540af79b0426b
BLAKE2b-256 378272852fd6341483e72f8d34c298ec39d8238c7e1bdad32daa1cc03ceef8c9

See more details on using hashes here.

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