pyflakes


Namepyflakes JSON
Version 1.6.0 PyPI version JSON
download
home_pagehttps://github.com/PyCQA/pyflakes
Summarypassive checker of Python programs
upload_time2017-08-03 14:54:14
maintainer
docs_urlNone
authorA lot of people
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ========
Pyflakes
========

A simple program which checks Python source files for errors.

Pyflakes analyzes programs and detects various errors.  It works by
parsing the source file, not importing it, so it is safe to use on
modules with side effects.  It's also much faster.

It is `available on PyPI <https://pypi.python.org/pypi/pyflakes>`_
and it supports all active versions of Python from 2.5 to 3.6.



Installation
------------

It can be installed with::

  $ pip install --upgrade pyflakes


Useful tips:

* Be sure to install it for a version of Python which is compatible
  with your codebase: for Python 2, ``pip2 install pyflakes`` and for
  Python3, ``pip3 install pyflakes``.

* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
  ``python2 -m pyflakes .`` if you have it installed for both versions.

* If you require more options and more flexibility, you could give a
  look to Flake8_ too.
  

Design Principles
-----------------
Pyflakes makes a simple promise: it will never complain about style,
and it will try very, very hard to never emit false positives.

Pyflakes is also faster than Pylint_
or Pychecker_. This is
largely because Pyflakes only examines the syntax tree of each file
individually. As a consequence, Pyflakes is more limited in the
types of things it can check.

If you like Pyflakes but also want stylistic checks, you want
flake8_, which combines
Pyflakes with style checks against
`PEP 8`_ and adds
per-project configuration ability.


Mailing-list
------------

Share your feedback and ideas: `subscribe to the mailing-list
<https://mail.python.org/mailman/listinfo/code-quality>`_

Contributing
------------

Issues are tracked on `GitHub <https://github.com/PyCQA/pyflakes/issues>`_.

Patches may be submitted via a `GitHub pull request`_ or via the mailing list
if you prefer. If you are comfortable doing so, please `rebase your changes`_
so they may be applied to master with a fast-forward merge, and each commit is
a coherent unit of work with a well-written log message.  If you are not
comfortable with this rebase workflow, the project maintainers will be happy to
rebase your commits for you.

All changes should include tests and pass flake8_.

.. image:: https://api.travis-ci.org/PyCQA/pyflakes.svg?branch=master
   :target: https://travis-ci.org/PyCQA/pyflakes
   :alt: Build status

.. _Pylint: http://www.pylint.org/
.. _flake8: https://pypi.python.org/pypi/flake8
.. _`PEP 8`: http://legacy.python.org/dev/peps/pep-0008/
.. _Pychecker: http://pychecker.sourceforge.net/
.. _`rebase your changes`: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
.. _`GitHub pull request`: https://github.com/PyCQA/pyflakes/pulls

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2017-08-03 14:54:14", 
    "author": "A lot of people", 
    "home_page": "https://github.com/PyCQA/pyflakes", 
    "github_user": "PyCQA", 
    "download_url": "https://pypi.python.org/packages/26/85/f6a315cd3c1aa597fb3a04cc7d7dbea5b3cc66ea6bd13dfa0478bf4876e6/pyflakes-1.6.0.tar.gz", 
    "platform": "", 
    "version": "1.6.0", 
    "cheesecake_documentation_id": null, 
    "description": "========\nPyflakes\n========\n\nA simple program which checks Python source files for errors.\n\nPyflakes analyzes programs and detects various errors.  It works by\nparsing the source file, not importing it, so it is safe to use on\nmodules with side effects.  It's also much faster.\n\nIt is `available on PyPI <https://pypi.python.org/pypi/pyflakes>`_\nand it supports all active versions of Python from 2.5 to 3.6.\n\n\n\nInstallation\n------------\n\nIt can be installed with::\n\n  $ pip install --upgrade pyflakes\n\n\nUseful tips:\n\n* Be sure to install it for a version of Python which is compatible\n  with your codebase: for Python 2, ``pip2 install pyflakes`` and for\n  Python3, ``pip3 install pyflakes``.\n\n* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or\n  ``python2 -m pyflakes .`` if you have it installed for both versions.\n\n* If you require more options and more flexibility, you could give a\n  look to Flake8_ too.\n  \n\nDesign Principles\n-----------------\nPyflakes makes a simple promise: it will never complain about style,\nand it will try very, very hard to never emit false positives.\n\nPyflakes is also faster than Pylint_\nor Pychecker_. This is\nlargely because Pyflakes only examines the syntax tree of each file\nindividually. As a consequence, Pyflakes is more limited in the\ntypes of things it can check.\n\nIf you like Pyflakes but also want stylistic checks, you want\nflake8_, which combines\nPyflakes with style checks against\n`PEP 8`_ and adds\nper-project configuration ability.\n\n\nMailing-list\n------------\n\nShare your feedback and ideas: `subscribe to the mailing-list\n<https://mail.python.org/mailman/listinfo/code-quality>`_\n\nContributing\n------------\n\nIssues are tracked on `GitHub <https://github.com/PyCQA/pyflakes/issues>`_.\n\nPatches may be submitted via a `GitHub pull request`_ or via the mailing list\nif you prefer. If you are comfortable doing so, please `rebase your changes`_\nso they may be applied to master with a fast-forward merge, and each commit is\na coherent unit of work with a well-written log message.  If you are not\ncomfortable with this rebase workflow, the project maintainers will be happy to\nrebase your commits for you.\n\nAll changes should include tests and pass flake8_.\n\n.. image:: https://api.travis-ci.org/PyCQA/pyflakes.svg?branch=master\n   :target: https://travis-ci.org/PyCQA/pyflakes\n   :alt: Build status\n\n.. _Pylint: http://www.pylint.org/\n.. _flake8: https://pypi.python.org/pypi/flake8\n.. _`PEP 8`: http://legacy.python.org/dev/peps/pep-0008/\n.. _Pychecker: http://pychecker.sourceforge.net/\n.. _`rebase your changes`: https://git-scm.com/book/en/v2/Git-Branching-Rebasing\n.. _`GitHub pull request`: https://github.com/PyCQA/pyflakes/pulls\n", 
    "tox": true, 
    "lcname": "pyflakes", 
    "bugtrack_url": "", 
    "github": true, 
    "coveralls": false, 
    "name": "pyflakes", 
    "license": "MIT", 
    "travis_ci": true, 
    "github_project": "pyflakes", 
    "summary": "passive checker of Python programs", 
    "split_keywords": [], 
    "author_email": "code-quality@python.org", 
    "urls": [
        {
            "has_sig": true, 
            "upload_time": "2017-08-03T14:54:17", 
            "comment_text": "", 
            "python_version": "2.7", 
            "url": "https://pypi.python.org/packages/d7/40/733bcc64da3161ae4122c11e88269f276358ca29335468005cb0ee538665/pyflakes-1.6.0-py2.py3-none-any.whl", 
            "md5_digest": "aceccaed060a527a78365a7653e4e99d", 
            "downloads": 0, 
            "filename": "pyflakes-1.6.0-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "d7/40/733bcc64da3161ae4122c11e88269f276358ca29335468005cb0ee538665/pyflakes-1.6.0-py2.py3-none-any.whl", 
            "size": 227402
        }, 
        {
            "has_sig": true, 
            "upload_time": "2017-08-03T14:54:14", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/26/85/f6a315cd3c1aa597fb3a04cc7d7dbea5b3cc66ea6bd13dfa0478bf4876e6/pyflakes-1.6.0.tar.gz", 
            "md5_digest": "b385b0e4cd40a522553e97cd2d83573e", 
            "downloads": 0, 
            "filename": "pyflakes-1.6.0.tar.gz", 
            "packagetype": "sdist", 
            "path": "26/85/f6a315cd3c1aa597fb3a04cc7d7dbea5b3cc66ea6bd13dfa0478bf4876e6/pyflakes-1.6.0.tar.gz", 
            "size": 48184
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}