pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-03-29 18:46:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
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://flake8.pycqa.org
1060 commits 2 branches 92 tags 4.8 MiB
Find a file
Fabian Neundorf 965d6f9509 Fix typo in documentation using indect 
The documentation for the `FileProcessor` class used `indect_char` while the
class itself uses the more sensible name `indent_char`. This updates both the
docstring as well as the documentation.
2016-07-21 13:59:07 +02:00
docs Fix typo in documentation using indect 2016-07-21 13:59:07 +02:00
src/flake8 Fix typo in documentation using indect 2016-07-21 13:59:07 +02:00
tests Fix up merge request 78 2016-07-20 19:28:13 -05:00
.bandit.yml Configure bandit to ignore subprocess warnings 2016-06-14 07:58:13 -05:00
.gitignore Merge remote-tracking branch 'rewrite/master' into proposed/3.0 2016-03-15 16:00:19 -05:00
.gitlab-ci.yml Add python*-dev packages 2016-06-25 16:00:45 -05:00
.hgignore Ignore ./.tox directory 2014-03-30 23:54:36 +02:00
.hgtags Release v2.2.3 2014-08-25 19:03:13 -05:00
.pylintrc Fix our evaluation formula 2016-02-19 15:30:54 -06:00
.travis.yml Remove mypy from list of tox environments 2016-06-20 13:29:53 -05:00
CONTRIBUTING.rst Symlink the contributing docs to CONTRIBUTING 2016-06-04 15:46:51 -05:00
CONTRIBUTORS.txt Adding myself to CONTRIBUTORS.txt 2016-06-10 11:28:48 +03:00
dev-requirements.txt Switch out dev-requirements for tox 2016-03-17 14:56:54 -05:00
LICENSE Update the copyright in the LICENSE 2016-06-25 10:49:32 -05:00
MANIFEST.in Fix up MANIFEST.in 2016-06-30 15:34:29 -05:00
README.rst Update the README 2016-06-25 20:09:56 -05:00
setup.cfg Update the packaging so wheels work 2016-06-25 11:20:28 -05:00
setup.py Clean up setup.py a bit 2016-06-30 16:03:02 -05:00
tox.ini Add build testenv for future CI work 2016-07-10 09:31:43 -05:00

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``
- Git and Mercurial hooks
- extendable through ``flake8.extension`` and ``flake8.formatting`` entry
  points


Quickstart
==========

See our `quickstart documentation
<http://flake8.pycqa.org/en/latest/index.html#quickstart>`_ for how to install
and get started with Flake8.


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

Flake8 maintains an `FAQ <http://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/>`_

* `GitLab Project <https://gitlab.com/pycqa/flake8>`_

* `All (Open and Closed) Issues
  <https://gitlab.com/pycqa/flake8/issues?scope=all&sort=updated_desc&state=all>`_

* `Code-Quality Archives
  <https://mail.python.org/mailman/listinfo/code-quality>`-

* `Code of Conduct
  <http://flake8.pycqa.org/en/latest/internal/contributing.html#code-of-conduct>`_

* `Getting Started Contributing
  <http://flake8.pycqa.org/en/latest/internal/contributing.html>`_


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

Flake8 was created by Tarek Ziadé and is currently maintained by `Ian Cordasco
<https://coglib.com/~icordasc/>`_