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.
  • Caching for much better performance.
  • 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.

Files for flakehell, version 0.3.3
Filename, size File type Python version Upload date Hashes
Filename, size flakehell-0.3.3-py3-none-any.whl (30.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size flakehell-0.3.3.tar.gz (21.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page