projects / config.git / blame
| Commit | Line | Data |
|---|---|---|
| 53e6db90 DC |
1 | Metadata-Version: 2.1 |
| 2 | Name: flake8 | |
| 3 | Version: 6.1.0 | |
| 4 | Summary: the modular source code checker: pep8 pyflakes and co | |
| 5 | Home-page: https://github.com/pycqa/flake8 | |
| 6 | Author: Tarek Ziade | |
| 7 | Author-email: tarek@ziade.org | |
| 8 | Maintainer: Ian Stapleton Cordasco | |
| 9 | Maintainer-email: graffatcolmingov@gmail.com | |
| 10 | License: MIT | |
| 11 | Classifier: Development Status :: 5 - Production/Stable | |
| 12 | Classifier: Environment :: Console | |
| 13 | Classifier: Framework :: Flake8 | |
| 14 | Classifier: Intended Audience :: Developers | |
| 15 | Classifier: License :: OSI Approved :: MIT License | |
| 16 | Classifier: Programming Language :: Python | |
| 17 | Classifier: Programming Language :: Python :: 3 | |
| 18 | Classifier: Programming Language :: Python :: 3 :: Only | |
| 19 | Classifier: Programming Language :: Python :: Implementation :: CPython | |
| 20 | Classifier: Programming Language :: Python :: Implementation :: PyPy | |
| 21 | Classifier: Topic :: Software Development :: Libraries :: Python Modules | |
| 22 | Classifier: Topic :: Software Development :: Quality Assurance | |
| 23 | Requires-Python: >=3.8.1 | |
| 24 | Description-Content-Type: text/x-rst | |
| 25 | License-File: LICENSE | |
| 26 | Requires-Dist: mccabe (<0.8.0,>=0.7.0) | |
| 27 | Requires-Dist: pycodestyle (<2.12.0,>=2.11.0) | |
| 28 | Requires-Dist: pyflakes (<3.2.0,>=3.1.0) | |
| 29 | ||
| 30 | .. image:: https://github.com/PyCQA/flake8/workflows/main/badge.svg | |
| 31 | :target: https://github.com/PyCQA/flake8/actions?query=workflow%3Amain | |
| 32 | :alt: build status | |
| 33 | ||
| 34 | .. image:: https://results.pre-commit.ci/badge/github/PyCQA/flake8/main.svg | |
| 35 | :target: https://results.pre-commit.ci/latest/github/PyCQA/flake8/main | |
| 36 | :alt: pre-commit.ci status | |
| 37 | ||
| 38 | .. image:: https://img.shields.io/discord/825463413634891776.svg | |
| 39 | :target: https://discord.gg/qYxpadCgkx | |
| 40 | :alt: Discord | |
| 41 | ||
| 42 | ======== | |
| 43 | Flake8 | |
| 44 | ======== | |
| 45 | ||
| 46 | Flake8 is a wrapper around these tools: | |
| 47 | ||
| 48 | - PyFlakes | |
| 49 | - pycodestyle | |
| 50 | - Ned Batchelder's McCabe script | |
| 51 | ||
| 52 | Flake8 runs all the tools by launching the single ``flake8`` command. | |
| 53 | It displays the warnings in a per-file, merged output. | |
| 54 | ||
| 55 | It also adds a few features: | |
| 56 | ||
| 57 | - files that contain this line are skipped:: | |
| 58 | ||
| 59 | # flake8: noqa | |
| 60 | ||
| 61 | - lines that contain a ``# noqa`` comment at the end will not issue warnings. | |
| 62 | - you can ignore specific errors on a line with ``# noqa: <error>``, e.g., | |
| 63 | ``# 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 | |
| 64 | - Git and Mercurial hooks | |
| 65 | - extendable through ``flake8.extension`` and ``flake8.formatting`` entry | |
| 66 | points | |
| 67 | ||
| 68 | ||
| 69 | Quickstart | |
| 70 | ========== | |
| 71 | ||
| 72 | See our `quickstart documentation | |
| 73 | <https://flake8.pycqa.org/en/latest/index.html#quickstart>`_ for how to install | |
| 74 | and get started with Flake8. | |
| 75 | ||
| 76 | ||
| 77 | Frequently Asked Questions | |
| 78 | ========================== | |
| 79 | ||
| 80 | Flake8 maintains an `FAQ <https://flake8.pycqa.org/en/latest/faq.html>`_ in its | |
| 81 | documentation. | |
| 82 | ||
| 83 | ||
| 84 | Questions or Feedback | |
| 85 | ===================== | |
| 86 | ||
| 87 | If you have questions you'd like to ask the developers, or feedback you'd like | |
| 88 | to provide, feel free to use the mailing list: code-quality@python.org | |
| 89 | ||
| 90 | We would love to hear from you. Additionally, if you have a feature you'd like | |
| 91 | to suggest, the mailing list would be the best place for it. | |
| 92 | ||
| 93 | ||
| 94 | Links | |
| 95 | ===== | |
| 96 | ||
| 97 | * `Flake8 Documentation <https://flake8.pycqa.org/en/latest/>`_ | |
| 98 | ||
| 99 | * `GitHub Project <https://github.com/pycqa/flake8>`_ | |
| 100 | ||
| 101 | * `All (Open and Closed) Issues | |
| 102 | <https://github.com/pycqa/flake8/issues?q=is%3Aissue>`_ | |
| 103 | ||
| 104 | * `Code-Quality Archives | |
| 105 | <https://mail.python.org/mailman/listinfo/code-quality>`_ | |
| 106 | ||
| 107 | * `Code of Conduct | |
| 108 | <https://flake8.pycqa.org/en/latest/internal/contributing.html#code-of-conduct>`_ | |
| 109 | ||
| 110 | * `Getting Started Contributing | |
| 111 | <https://flake8.pycqa.org/en/latest/internal/contributing.html>`_ | |
| 112 | ||
| 113 | ||
| 114 | Maintenance | |
| 115 | =========== | |
| 116 | ||
| 117 | Flake8 was created by Tarek Ziadé and is currently maintained by `anthony sottile | |
| 118 | <https://github.com/sponsors/asottile>`_ and `Ian Cordasco | |
| 119 | <https://www.coglib.com/~icordasc/>`_ |