pyproject-flake8 (`pflake8`), a monkey patching wrapper to connect flake8 with pyproject.toml configuration
Project description
pyproject-flake8 (pflake8
)
A monkey patching wrapper to connect flake8 with pyproject.toml
configuration.
Rationale
flake8
is one of the most popular Python linters, pyproject.toml
has become the standard for Python project metadata.
More and more tools are able to utilize a shared pyproject.toml
, alleviating the need for many individual configuration files cluttering a project repository.
Since excellent flake8
is not aimed to support pyproject.toml
, this wrapper script tries to fix the situation.
Installation
From github
pip install .
From PyPI
pip install pyproject-flake8
Building packages
Use your favorite PEP517 compliant builder, e.g.:
# install first via: pip install build
python -m build
# packges will reside in dist/
Usage
Call pflake8
instead of flake8
.
Configuration goes into the tool.flake8
section of pyproject.toml
:
[tool.flake8]
max-line-length = 88
extend-ignore = "E203,"
max-complexity = 10
See also
Two other projects aim to address the same problem:
Both seem to try to do a lot more than just getting pyproject.toml
support. pyproject-flake8
tries to stay minimal while solving its task (with currently around 40 lines).
Caveat
This script monkey-patches flake8 and the configparser library of Python, therefore loading it as a module may have unforeseen consequences. Alpha quality. Use at your own risk. It will likely break if either Python or flake8 restructure their code significantly. No guarantees for stability between versions.
License
Unlicense
Project details
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
Built Distribution
Hashes for pyproject_flake8-0.0.1a3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f434780791df82e9ca2358f4c542a2b2fdd3a77e666a6ad3f60a6a1464da4e2 |
|
MD5 | 8cc057e647ab4f0afd37d8e578959ba2 |
|
BLAKE2b-256 | f73ffa42d3bb24a4f64f108294206181a70ed8e3fc748ef978512acc844a432d |