mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-31 19:26:52 +00:00
90 lines
2.6 KiB
ReStructuredText
90 lines
2.6 KiB
ReStructuredText
.. image:: https://github.com/PyCQA/flake8/workflows/main/badge.svg
|
||
:target: https://github.com/PyCQA/flake8/actions?query=workflow%3Amain
|
||
:alt: build status
|
||
|
||
.. image:: https://results.pre-commit.ci/badge/github/PyCQA/flake8/main.svg
|
||
:target: https://results.pre-commit.ci/latest/github/PyCQA/flake8/main
|
||
:alt: pre-commit.ci status
|
||
|
||
.. image:: https://img.shields.io/discord/825463413634891776.svg
|
||
:target: https://discord.gg/qYxpadCgkx
|
||
:alt: Discord
|
||
|
||
========
|
||
Flake8
|
||
========
|
||
|
||
Flake8 is a wrapper around these tools:
|
||
|
||
- PyFlakes
|
||
- pycodestyle
|
||
- Ned Batchelder's McCabe script
|
||
|
||
Flake8 runs all the tools by launching the single ``flake8`` command.
|
||
It displays the warnings in a per-file, merged output.
|
||
|
||
It also adds a few features:
|
||
|
||
- files that contain this line are skipped::
|
||
|
||
# flake8: noqa
|
||
|
||
- lines that contain a ``# noqa`` comment at the end will not issue warnings.
|
||
- you can ignore specific errors on a line with ``# noqa: <error>``, e.g.,
|
||
``# noqa: E234``. Multiple codes can be given, separated by comma. The ``noqa`` token is case insensitive, the colon before the list of codes is required otherwise the part after ``noqa`` is ignored
|
||
- Git and Mercurial hooks
|
||
- extendable through ``flake8.extension`` and ``flake8.formatting`` entry
|
||
points
|
||
|
||
|
||
Quickstart
|
||
==========
|
||
|
||
See our `quickstart documentation
|
||
<https://flake8.pycqa.org/en/latest/index.html#quickstart>`_ for how to install
|
||
and get started with Flake8.
|
||
|
||
|
||
Frequentlу Asked Questions
|
||
==========================
|
||
|
||
Flake8 maintains an `FAQ <https://flake8.pycqa.org/en/latest/faq.html>`_ in its
|
||
documentation.
|
||
|
||
|
||
Questions or Feedback
|
||
=====================
|
||
|
||
If you have questions you'd like to ask the developers, or feedback you'd like
|
||
to provide, feel free to use the mailing list: code-quality@python.org
|
||
|
||
We would love to hear from you. Additionally, if you have a feature you'd like
|
||
to suggest, the mailing list would be the best place for it.
|
||
|
||
|
||
Links
|
||
=====
|
||
|
||
* `Flake8 Documentation <https://flake8.pycqa.org/en/latest/>`_
|
||
|
||
* `GitHub Project <https://github.com/pycqa/flake8>`_
|
||
|
||
* `All (Open and Closed) Issues
|
||
<https://github.com/pycqa/flake8/issues?q=is%3Aissue>`_
|
||
|
||
* `Code-Quality Archives
|
||
<https://mail.python.org/mailman/listinfo/code-quality>`_
|
||
|
||
* `Code of Conduct
|
||
<https://flake8.pycqa.org/en/latest/internal/contributing.html#code-of-conduct>`_
|
||
|
||
* `Getting Started Contributing
|
||
<https://flake8.pycqa.org/en/latest/internal/contributing.html>`_
|
||
|
||
|
||
Maintenance
|
||
===========
|
||
|
||
Flake8 was created by Tarek Ziadé and is currently maintained by `anthony sottile
|
||
<https://github.com/sponsors/asottile>`_ and `Ian Cordasco
|
||
<https://www.coglib.com/~icordasc/>`_
|