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.4.0.tar.gz
(23.9 kB
view details)
Built Distribution
flakehell-0.4.0-py3-none-any.whl
(31.7 kB
view details)
File details
Details for the file flakehell-0.4.0.tar.gz.
File metadata
- Download URL: flakehell-0.4.0.tar.gz
- Upload date:
- Size: 23.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c0ce3af4408e1ac24fa9d81bfa6d14beb093d162ecfd1db720ad76f1f3fa0a06 |
|
| MD5 | db8528ed8fabecd4c1aaf4e794a458cf |
|
| BLAKE2b-256 | fc0087ef93bc1565d3f2c5df9205fc7f2e627c0bc18c261c314415be1b0f333f |
File details
Details for the file flakehell-0.4.0-py3-none-any.whl.
File metadata
- Download URL: flakehell-0.4.0-py3-none-any.whl
- Upload date:
- Size: 31.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 090e44ddd3ef612532c7dc582ea9ad0f002cdd2ac9f24211dc6052597cdaa037 |
|
| MD5 | 8a14fa66d5495a8bef3fa606dee185de |
|
| BLAKE2b-256 | 54e90baaf577428da808b6a1b096615edbdc2ddaac4d2b907736746a42880dd5 |
