Skip to main content

Flake8 wrapper to make it nice and configurable

Project description

FlakeHell
PyPI version Build Status License: MIT Documentation

It’s a Flake8 wrapper to make it cool.

  • Shareable 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.

  • Allow codes intersection for different plugins.

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.

The FlakeHell mascot (Flaky) is created by @diana_leit and licensed under the CC BY-SA 4.0 license.

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.3.0.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

flakehell-0.3.0-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flakehell-0.3.0.tar.gz
  • Upload date:
  • Size: 21.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.3.0.tar.gz
Algorithm Hash digest
SHA256 75b9fd01e228ea5e9f4a96e1dc1f5493c044dcbfd2d8917ef67ab1b900e8601c
MD5 579e2cd4c8def580cc90c086bf72648a
BLAKE2b-256 d914bf24e2978dac6c84462bbb1fa7f43e6a2253a0c9a88c03ab2073e67a8177

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flakehell-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 28.4 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 657b755cd67d01be5726ac8d7291d45ad3ba2e5910ab1ac61cfd2b37a9e12654
MD5 dff2a3aaed89394cb01e76f5f4b8a4f1
BLAKE2b-256 68cb4865d8091c1cf19946ed0e4580977bb80cf74b7b206f7e9227e666308c9c

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