Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/PyCQA/flake8

flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
https://github.com/PyCQA/flake8

complexity-analysis flake8 linter linter-flake8 pep8 python python3 static-analysis static-code-analysis style-guide styleguide stylelint

Last synced: about 1 month ago
JSON representation

flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.

Awesome Lists containing this project

README

        

.. 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: ``, 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
`_ for how to install
and get started with Flake8.

Frequently Asked Questions
==========================

Flake8 maintains an `FAQ `_ 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: [email protected]

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 `_

* `GitHub Project `_

* `All (Open and Closed) Issues
`_

* `Code-Quality Archives
`_

* `Code of Conduct
`_

* `Getting Started Contributing
`_

Maintenance
===========

Flake8 was created by Tarek Ziadé and is currently maintained by `anthony sottile
`_ and `Ian Cordasco
`_