Skip to content

Commit

Permalink
Updated README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
pypros committed Oct 27, 2024
1 parent 61ad7cb commit f936b50
Showing 1 changed file with 64 additions and 8 deletions.
72 changes: 64 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
.. image:: https://img.shields.io/pypi/v/pytest-flake8.svg
.. image:: https://img.shields.io/pypi/v/pytest-flake8.svg?label=python-flake8
:target: https://pypi.org/project/pytest-flake8
:alt: Package


.. image:: https://readthedocs.org/projects/pytest-flake8/badge
:target: https://pytest-flake8.readthedocs.io/en/latest
:alt: Documentation

.. 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
:target: https://github.com/PyCQA/flake8/actions?query=workflow=main
:alt: Tests


.. image:: https://img.shields.io/pypi/v/flake8.svg?label=flake8
:target: https://github.com/PyCQA/flake8
:alt: Flake8


.. 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
:alt: skeleton


pytest plugin for efficiently checking PEP8 compliance
Expand All @@ -24,7 +34,9 @@ pytest plugin for efficiently checking PEP8 compliance
Usage
-----

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

.. code-block:: bash
pytest --flake8
Expand Down Expand Up @@ -60,7 +72,51 @@ All the Flake8 tests are skipping!

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

Run with ``pytest --cache-clear --flake8`` to bypass.
To bypass this caching mechanism, run the following command:

.. code-block:: bash
pytest --cache-clear --flake8
Note to developers
------------------

Setup environment
^^^^^^^^^^^^^^^^^

Separate virtual environments(venv) should be set up.

.. code-block:: bash
python3 -m venv .venv
Switch to venv.

.. code-block:: bash
source .venv/bin/activate
Install tox
^^^^^^^^^^^

Separate virtual environments should be set up.

.. code-block:: bash
pip install tox
Run environment
^^^^^^^^^^^^^^^

Run tox.

.. code-block:: bash
tox
For more information, you can take a look at the `skeleton <https://blog.jaraco.com/skeleton/>`_.


Notes
-----
Expand Down

0 comments on commit f936b50

Please sign in to comment.