Metadata-Version: 2.1
Name: flake518
Version: 1.1.0
Summary: A small wrapper around flake8 to support PEP518 pyproject.toml as configuration file.
License: MIT
Author-email: Carsten Igel <cig@bite-that-bit.de>
Requires-Python: >=3.6, <4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Project-URL: homepage, https://github.com/carstencodes/flake518
Description-Content-Type: text/markdown
Description: # Flake518
        
        A small wrapper around the famous [flake8](https://flake8.pycqa.org/) tool empowering it to read
        the configuration not from `setup.cfg`, `tox.ini` or `.flake8`, but from the [PEP518](https://www.python.org/dev/peps/pep-0518/)
        compliant `pyproject.toml`.
        
        In contrast to [flake9](https://gitlab.com/retnikt/flake9) it is not a fork of flake8. It uses flake8 under the hood and transforms
        the relevant configuration to a flake8 configuration file. This way, the ongoing implementation of flake8 can be used.
        
        ## Rational
        
        The usage of `pyproject.toml` is though highly anticipated by some community members, but currently [rejected](https://github.com/PyCQA/flake8/issues/234) by the maintainers for an undisclosed reason. Flake9 already uses the `pyproject.toml` file, but does not incorporate later changes.
        
        Since flake8 allows to pass additional configuration files, a temporary configuration file is created. This way, the latest flake8 revision is used, but it can be configured using `pyproject.toml`.
        
        ## Configuration
        
        According to PEP518, each tool may add a tool-specific table to the project configuration.
        
        ```toml
        [tool.flake8]
        statistics=True
        show-source=True
        max-line-length=79
        doctests=True
        exclude=[".git", "__pypackages__", ".vscode", ".mypy_cache"]
        ```
        
        For compliance reason, the `[tool.flake518]` can be used as well.
        
        ## License
        
        Like flake8, this project is licensed under the MIT license.
        
        ## Contributions
        
        Contributions welcome, feel free to submit issues and pull requests on github.
        Contact me, if you are using gitlab or codeberg.

