| Name | pytest-flake8 JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | pytest plugin to check FLAKE8 requirements |
| upload_time | 2024-11-09 00:09:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. 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
Raw data
{
"_id": null,
"home_page": null,
"name": "pytest-flake8",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"Jason R. Coombs\" <jaraco@jaraco.com>",
"keywords": null,
"author": null,
"author_email": "Thorsten Lockert <tholo@sigmasoft.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/83/3b0154ccd60191e24b75c99c5e7c6dcfb1d2fd81dd47528523b38fed6ac6/pytest_flake8-1.3.0.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/pytest-flake8.svg\n :target: https://pypi.org/project/pytest-flake8\n\n.. image:: https://img.shields.io/pypi/pyversions/pytest-flake8.svg\n\n.. image:: https://github.com/coherent-oss/pytest-flake8/actions/workflows/main.yml/badge.svg\n :target: https://github.com/coherent-oss/pytest-flake8/actions?query=workflow%3A%22tests%22\n :alt: tests\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n\n.. image:: https://readthedocs.org/projects/pytest-flake8/badge/?version=latest\n :target: https://pytest-flake8.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/badge/skeleton-2024-informational\n :target: https://blog.jaraco.com/skeleton\n\n\npytest plugin for efficiently checking PEP8 compliance \n======================================================\n\nUsage\n-----\n\nInstall it into a test environment, then run tests with the option.\n\n.. code-block:: bash\n\n pytest --flake8\n\nEvery file ending in ``.py`` will be discovered and checked with\nflake8.\n\n.. note::\n\n If optional flake8 plugins are installed, those will\n be used automatically. No provisions have been made for\n configuring these via `pytest`_.\n\n.. warning::\n\n Running flake8 tests on your project is likely to cause a number \n of issues. The plugin allows one to configure on a per-project and\n per-file basis which errors or warnings to ignore, see\n flake8-ignore_.\n\n.. _flake8-ignore:\n\nConfiguring Flake8\n------------------\n\nSee the Flake8\n`docs on configuring <https://flake8.pycqa.org/en/latest/user/configuration.html>`_.\n\nFAQs\n-----\n\nAll the Flake8 tests are skipping!\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nBy design, results are cached and only changed files are checked.\n\nTo bypass this caching mechanism, run the following command:\n\n.. code-block:: bash\n\n pytest --cache-clear --flake8\n\nRun tests with [tox](https://tox.wiki) (e.g. `pipx run tox`).\n\nFor more information, take a look at the `skeleton <https://blog.jaraco.com/skeleton/>`_.\n\n\nNotes\n-----\n\nFor more info on `pytest`_ see http://pytest.org\n\nThe code is partially based on Ronny Pfannschmidt's `pytest-codecheckers`_ plugin.\n\n.. _`pytest`: http://pytest.org\n.. _`flake8`: https://pypi.python.org/pypi/flake8\n.. _`pycodestyle`: https://pypi.python.org/pypi/pycodestyle\n.. _`pytest-codecheckers`: https://pypi.python.org/pypi/pytest-codecheckers\n",
"bugtrack_url": null,
"license": null,
"summary": "pytest plugin to check FLAKE8 requirements",
"version": "1.3.0",
"project_urls": {
"Source": "https://github.com/coherent-oss/pytest-flake8"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7dca163e24b6d92ba3e92245a6a23e88b946c29ff5294b2f4bc24c7a6171a13d",
"md5": "c3b359758f0d45e826abfb7f35007f88",
"sha256": "de10517c59fce25c0a7abb2a2b2a9d0b0ceb59ff0add7fa8e654d613bb25e218"
},
"downloads": -1,
"filename": "pytest_flake8-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3b359758f0d45e826abfb7f35007f88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5966,
"upload_time": "2024-11-09T00:09:08",
"upload_time_iso_8601": "2024-11-09T00:09:08.227776Z",
"url": "https://files.pythonhosted.org/packages/7d/ca/163e24b6d92ba3e92245a6a23e88b946c29ff5294b2f4bc24c7a6171a13d/pytest_flake8-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f833b0154ccd60191e24b75c99c5e7c6dcfb1d2fd81dd47528523b38fed6ac6",
"md5": "0f8b276a4ff9955c23f77997652cb0db",
"sha256": "88fb35562ce32d915c6ba41ef0d5e1cfcdd8ff884a32b7d46aa99fc77a3d1fe6"
},
"downloads": -1,
"filename": "pytest_flake8-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0f8b276a4ff9955c23f77997652cb0db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 13340,
"upload_time": "2024-11-09T00:09:09",
"upload_time_iso_8601": "2024-11-09T00:09:09.249233Z",
"url": "https://files.pythonhosted.org/packages/4f/83/3b0154ccd60191e24b75c99c5e7c6dcfb1d2fd81dd47528523b38fed6ac6/pytest_flake8-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 00:09:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "coherent-oss",
"github_project": "pytest-flake8",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pytest-flake8"
}
