Metadata-Version: 2.1
Name: flake8-pyprojecttoml
Version: 0.0.2
Summary: Inject pyproject.toml support into flake8.
Home-page: https://gitlab.com/durko/flake8-pyprojecttoml
Author: Marko Durkovic
Author-email: marko@miding.de
License: Apache 2.0
Project-URL: Code, https://gitlab.com/durko/flake8-pyprojecttoml
Project-URL: Documentation, https://durko.gitlab.io/flake8-pyprojecttoml
Project-URL: Issue tracker, https://gitlab.com/durko/flake8-pyprojecttoml/issues
Keywords: configuration,flake8,pyproject.toml
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: flake8
Requires-Dist: tomli ; python_version < "3.11"
Provides-Extra: dev
Requires-Dist: darglint ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-annotations ; extra == 'dev'
Requires-Dist: flake8-bugbear ; extra == 'dev'
Requires-Dist: flake8-commas ; extra == 'dev'
Requires-Dist: flake8-comprehensions ; extra == 'dev'
Requires-Dist: flake8-docstrings ; extra == 'dev'
Requires-Dist: flake8-fixme ; extra == 'dev'
Requires-Dist: flake8-isort ; extra == 'dev'
Requires-Dist: flake8-mutable ; extra == 'dev'
Requires-Dist: flake8-print ; extra == 'dev'
Requires-Dist: flake8-pytest-style ; extra == 'dev'
Requires-Dist: flake8-quotes ; extra == 'dev'
Requires-Dist: flake8-return ; extra == 'dev'
Requires-Dist: flake8-simplify ; extra == 'dev'
Requires-Dist: flake8-type-checking ; extra == 'dev'
Requires-Dist: flake8-use-fstring ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pep8-naming ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: toml ; extra == 'dev'
Requires-Dist: yapf ; extra == 'dev'

.. image:: https://gitlab.com/durko/flake8-pyprojecttoml/badges/master/pipeline.svg
   :target: https://gitlab.com/durko/flake8-pyprojecttoml/-/commits/master
   :alt: pipeline status

.. image:: https://gitlab.com/durko/flake8-pyprojecttoml/badges/master/coverage.svg
   :target: https://gitlab.com/durko/flake8-pyprojecttoml/-/commits/master
   :alt: coverage report

.. image:: https://img.shields.io/pypi/pyversions/flake8-pyprojecttoml
   :alt: python versions


====================
flake8-pyprojecttoml
====================

This extension adds support reading flake8 config from **pyproject.toml**. It uses flake8's plugin system to automatically monkeypatch the config system. Settings from pyproject.toml will be used regardless of invocation (CLI, pytest, IDE, ...).


Getting started
===============

Simply install with pip::

   pip install flake8-pyprojecttoml


Migrate your flake8 config to pyproject.toml (`example <https://gitlab.com/durko/flake8-pyprojecttoml/-/blob/master/pyproject.toml>`_) and use as usual.


Contributing
============

Thank you for considering to contribute to flake8-pyprojecttoml.

To submit issues or create merge requests please follow the instructions provided in the `contribution guide <https://gitlab.com/durko/flake8-pyprojecttoml/-/blob/master/CONTRIBUTING.rst>`_.

By contributing to flake8-pyprojecttoml you accept and agree to the terms and conditions laid out in there.


Development
===========

Clone the repository and setup your local checkout::

   git clone https://gitlab.com/durko/flake8-pyprojecttoml.git
   
   cd flake8-pyprojecttoml
   python -m venv venv
   . venv/bin/activate
   
   pip install -r requirements-dev.txt
   pip install -e .


This creates a new virtual environment with the necessary python dependencies and installs flake8-pyprojecttoml in editable mode. The flake8-pyprojecttoml code base uses pytest as its test runner, run the test suite by simply invoking::

   pytest
