README.rst 2.42 KB
Newer Older
Anthony Sottile's avatar
Anthony Sottile committed
1
2
3
4
5
6
7
8
.. 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/master.svg
   :target: https://results.pre-commit.ci/latest/github/PyCQA/flake8/master
   :alt: pre-commit.ci status

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
9
10
11
========
 Flake8
========
Tarek Ziade's avatar
Tarek Ziade committed
12

13
Flake8 is a wrapper around these tools:
Tarek Ziade's avatar
Tarek Ziade committed
14

15
- PyFlakes
Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
16
- pycodestyle
17
- Ned Batchelder's McCabe script
18

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
19
Flake8 runs all the tools by launching the single ``flake8`` command.
20
It displays the warnings in a per-file, merged output.
Tarek Ziade's avatar
Tarek Ziade committed
21
22

It also adds a few features:
Tarek Ziade's avatar
Tarek Ziade committed
23

24
- files that contain this line are skipped::
Tarek Ziade's avatar
Tarek Ziade committed
25
26
27

    # flake8: noqa

28
- lines that contain a ``# noqa`` comment at the end will not issue warnings.
Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
29
- you can ignore specific errors on a line with ``# noqa: <error>``, e.g.,
30
  ``# 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
Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
31
32
33
- Git and Mercurial hooks
- extendable through ``flake8.extension`` and ``flake8.formatting`` entry
  points
34

Tarek Ziade's avatar
Tarek Ziade committed
35

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
36
Quickstart
37
==========
Tarek Ziade's avatar
Tarek Ziade committed
38

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
39
40
41
See our `quickstart documentation
<http://flake8.pycqa.org/en/latest/index.html#quickstart>`_ for how to install
and get started with Flake8.
42
43


Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
44
45
Frequently Asked Questions
==========================
46

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
47
48
Flake8 maintains an `FAQ <http://flake8.pycqa.org/en/latest/faq.html>`_ in its
documentation.
49
50


Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
51
52
Questions or Feedback
=====================
Tarek Ziade's avatar
Tarek Ziade committed
53

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
54
55
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
56

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
57
58
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.
59
60


Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
61
62
Links
=====
63

64
* `Flake8 Documentation <http://flake8.pycqa.org/en/latest/>`_
65

Anthony Sottile's avatar
Anthony Sottile committed
66
* `GitHub Project <https://github.com/pycqa/flake8>`_
67

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
68
* `All (Open and Closed) Issues
Anthony Sottile's avatar
Anthony Sottile committed
69
  <https://github.com/pycqa/flake8/issues?q=is%3Aissue>`_
70

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
71
* `Code-Quality Archives
Jason R. Coombs's avatar
Jason R. Coombs committed
72
  <https://mail.python.org/mailman/listinfo/code-quality>`_
73

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
74
75
* `Code of Conduct
  <http://flake8.pycqa.org/en/latest/internal/contributing.html#code-of-conduct>`_
Tarek Ziade's avatar
Tarek Ziade committed
76

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
77
78
* `Getting Started Contributing
  <http://flake8.pycqa.org/en/latest/internal/contributing.html>`_
79
80


Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
81
82
Maintenance
===========
83

Ian Stapleton Cordasco's avatar
Ian Stapleton Cordasco committed
84
Flake8 was created by Tarek Ziadé and is currently maintained by `Ian Cordasco
85
<http://www.coglib.com/~icordasc/>`_