Clone or download
asottile Merge branch 'grammar' into 'master'
Grammar fixes

See merge request pycqa/flake8!266
Latest commit cd75e4e Nov 11, 2018
Permalink
Failed to load latest commit information.
docs Grammar fixes Nov 11, 2018
example-plugin Add an example plugin project to source tree Oct 25, 2016
src/flake8 Grammar fixes Nov 11, 2018
tests Add tests for the expected behaviour of per-file-ignores Oct 27, 2018
.appveyor.yml Remove py33 from appveyor Jan 1, 2018
.bandit.yml Configure bandit to ignore subprocess warnings Jun 14, 2016
.coveragerc Add coverage reporting and uploading Aug 6, 2016
.gitignore Add coverage reporting and uploading Aug 6, 2016
.gitlab-ci.yml Use black to reformat Flake8 Oct 20, 2018
.hgignore Ignore ./.tox directory Mar 30, 2014
.hgtags Release v2.2.3 Aug 26, 2014
.mailmap Update name across the project post-marriage Jul 27, 2017
.pylintrc Spelling and grammar fixes May 13, 2018
.travis.yml Add Python 3.7 to tox and GitLab CI May 20, 2018
CONTRIBUTING.rst Add CONTRIBUTING.rst file refering to webpage. May 15, 2017
CONTRIBUTORS.txt Tidy up last few bits for performance improvement Dec 21, 2016
LICENSE Update the copyright in the LICENSE Jun 25, 2016
MANIFEST.in Revert "Update release machinery to include manpages" Nov 14, 2016
README.rst Clearer docs, NOQA_INLINE_REGEXP comment - fixes #469 Oct 28, 2018
codecov.yml Add coverage reporting and uploading Aug 6, 2016
dev-requirements.txt Switch out dev-requirements for tox Mar 17, 2016
pytest.ini setup.cfg: Move pytest options to pytest.ini Sep 18, 2016
setup.cfg Update to pyflakes 2.0.0 Jun 5, 2018
setup.py Release v3.6.0 Oct 24, 2018
tox.ini Use black to reformat Flake8 Oct 20, 2018

README.rst

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 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: 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

Maintenance

Flake8 was created by Tarek Ziadé and is currently maintained by Ian Cordasco