Metadata-Version: 2.4
Name: pytest-flake8
Version: 1.3.0
Summary: pytest plugin to check FLAKE8 requirements
Author-email: Thorsten Lockert <tholo@sigmasoft.com>
Maintainer-email: "Jason R. Coombs" <jaraco@jaraco.com>
Project-URL: Source, https://github.com/coherent-oss/pytest-flake8
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: flake8>=4.0
Requires-Dist: pytest>=7.0
Provides-Extra: test
Requires-Dist: pytest!=8.1.*,>=6; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx>=3.5; extra == "doc"
Requires-Dist: jaraco.packaging>=9.3; extra == "doc"
Requires-Dist: rst.linker>=1.9; extra == "doc"
Requires-Dist: furo; extra == "doc"
Requires-Dist: sphinx-lint; extra == "doc"
Provides-Extra: check
Requires-Dist: pytest-checkdocs>=2.4; extra == "check"
Requires-Dist: pytest-ruff>=0.2.1; sys_platform != "cygwin" and extra == "check"
Provides-Extra: cover
Requires-Dist: pytest-cov; extra == "cover"
Provides-Extra: enabler
Requires-Dist: pytest-enabler>=2.2; extra == "enabler"
Provides-Extra: type
Requires-Dist: pytest-mypy; extra == "type"
Dynamic: license-file

.. image:: https://img.shields.io/pypi/v/pytest-flake8.svg
   :target: https://pypi.org/project/pytest-flake8

.. image:: https://img.shields.io/pypi/pyversions/pytest-flake8.svg

.. image:: https://github.com/coherent-oss/pytest-flake8/actions/workflows/main.yml/badge.svg
   :target: https://github.com/coherent-oss/pytest-flake8/actions?query=workflow%3A%22tests%22
   :alt: tests

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

.. image:: https://readthedocs.org/projects/pytest-flake8/badge/?version=latest
   :target: https://pytest-flake8.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/skeleton-2024-informational
   :target: https://blog.jaraco.com/skeleton


pytest plugin for efficiently checking PEP8 compliance 
======================================================

Usage
-----

Install it into a test environment, then run tests with the option.

.. code-block:: bash

    pytest --flake8

Every file ending in ``.py`` will be discovered and checked with
flake8.

.. note::

    If optional flake8 plugins are installed, those will
    be used automatically. No provisions have been made for
    configuring these via `pytest`_.

.. warning::

    Running flake8 tests on your project is likely to cause a number 
    of issues. The plugin allows one to configure on a per-project and
    per-file basis which errors or warnings to ignore, see
    flake8-ignore_.

.. _flake8-ignore:

Configuring Flake8
------------------

See the Flake8
`docs on configuring <https://flake8.pycqa.org/en/latest/user/configuration.html>`_.

FAQs
-----

All the Flake8 tests are skipping!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By design, results are cached and only changed files are checked.

To bypass this caching mechanism, run the following command:

.. code-block:: bash

    pytest --cache-clear --flake8

Run tests with [tox](https://tox.wiki) (e.g. `pipx run tox`).

For more information, take a look at the `skeleton <https://blog.jaraco.com/skeleton/>`_.


Notes
-----

For more info on `pytest`_ see http://pytest.org

The code is partially based on Ronny Pfannschmidt's `pytest-codecheckers`_ plugin.

.. _`pytest`: http://pytest.org
.. _`flake8`: https://pypi.python.org/pypi/flake8
.. _`pycodestyle`: https://pypi.python.org/pypi/pycodestyle
.. _`pytest-codecheckers`: https://pypi.python.org/pypi/pytest-codecheckers
