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

Uploaded Source

Built Distribution

flakehell-0.3.2-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flakehell-0.3.2.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for flakehell-0.3.2.tar.gz
Algorithm Hash digest
SHA256 3fde9b72ff570a22894380dfd9cdd6d6a7ce16ea9156aaaa962528e54a7afc65
MD5 97a14e59ce729fb51986c510208c6b9f
BLAKE2b-256 dfd9e90f59f060df6b3e4dd37e2801359c7b4d27d68764aab3074fe774eebe52

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flakehell-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for flakehell-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2578a4110f021c88a582a2968a5a1f73766edf89c7189cf02cb94594b5cdd1d
MD5 7582600dcfd10ca26a8f927098dc5379
BLAKE2b-256 a2bc4e055f314e0ae992b7b526c5a24d80a969dde989480a009496a3c48ecf29

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