Flake8 wrapper to make it nice and configurable
Project description
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.
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
Show codes and messages for a specific plugin:
flakehell codes pyflakes
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.
Release history Release notifications | RSS feed
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.4.tar.gz
(22.9 kB
view details)
Built Distribution
flakehell-0.3.4-py3-none-any.whl
(31.2 kB
view details)
File details
Details for the file flakehell-0.3.4.tar.gz.
File metadata
- Download URL: flakehell-0.3.4.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3ee9155328a6ebebd5bd837c636d0e40e4a0a9561feebf8f15c37bd378eed050 |
|
| MD5 | 82c35fe3d2a68a80a26890afdfb424c5 |
|
| BLAKE2b-256 | c31b6ea61f35634a233acd8287ed83b02b989792ec9ca068e8a70f9d3d5e01de |
File details
Details for the file flakehell-0.3.4-py3-none-any.whl.
File metadata
- Download URL: flakehell-0.3.4-py3-none-any.whl
- Upload date:
- Size: 31.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f942dccf04851d10f588501a883f9b8e89154ecce1c017c94aa2ba91ba079f5d |
|
| MD5 | bb260e4914430d05833d05cb2d1e9019 |
|
| BLAKE2b-256 | a75e0683cf95728aa515a67fe1922eeb7ffcfb32b63c9f3c18af67a8314b6df1 |
