METADATA 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. Metadata-Version: 2.1
  2. Name: pyflakes
  3. Version: 2.5.0
  4. Summary: passive checker of Python programs
  5. Home-page: https://github.com/PyCQA/pyflakes
  6. Author: A lot of people
  7. Author-email: code-quality@python.org
  8. License: MIT
  9. Platform: UNKNOWN
  10. Classifier: Development Status :: 6 - Mature
  11. Classifier: Environment :: Console
  12. Classifier: Intended Audience :: Developers
  13. Classifier: License :: OSI Approved :: MIT License
  14. Classifier: Programming Language :: Python
  15. Classifier: Programming Language :: Python :: 3
  16. Classifier: Programming Language :: Python :: 3.6
  17. Classifier: Programming Language :: Python :: 3.7
  18. Classifier: Programming Language :: Python :: 3.8
  19. Classifier: Programming Language :: Python :: 3.9
  20. Classifier: Programming Language :: Python :: 3.10
  21. Classifier: Programming Language :: Python :: 3 :: Only
  22. Classifier: Programming Language :: Python :: Implementation :: CPython
  23. Classifier: Programming Language :: Python :: Implementation :: PyPy
  24. Classifier: Topic :: Software Development
  25. Classifier: Topic :: Utilities
  26. Requires-Python: >=3.6
  27. License-File: LICENSE
  28. ========
  29. Pyflakes
  30. ========
  31. A simple program which checks Python source files for errors.
  32. Pyflakes analyzes programs and detects various errors. It works by
  33. parsing the source file, not importing it, so it is safe to use on
  34. modules with side effects. It's also much faster.
  35. It is `available on PyPI <https://pypi.org/project/pyflakes/>`_
  36. and it supports all active versions of Python: 3.6+.
  37. Installation
  38. ------------
  39. It can be installed with::
  40. $ pip install --upgrade pyflakes
  41. Useful tips:
  42. * Be sure to install it for a version of Python which is compatible
  43. with your codebase: for Python 2, ``pip2 install pyflakes`` and for
  44. Python3, ``pip3 install pyflakes``.
  45. * You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
  46. ``python2 -m pyflakes .`` if you have it installed for both versions.
  47. * If you require more options and more flexibility, you could give a
  48. look to Flake8_ too.
  49. Design Principles
  50. -----------------
  51. Pyflakes makes a simple promise: it will never complain about style,
  52. and it will try very, very hard to never emit false positives.
  53. Pyflakes is also faster than Pylint_. This is
  54. largely because Pyflakes only examines the syntax tree of each file
  55. individually. As a consequence, Pyflakes is more limited in the
  56. types of things it can check.
  57. If you like Pyflakes but also want stylistic checks, you want
  58. flake8_, which combines
  59. Pyflakes with style checks against
  60. `PEP 8`_ and adds
  61. per-project configuration ability.
  62. Mailing-list
  63. ------------
  64. Share your feedback and ideas: `subscribe to the mailing-list
  65. <https://mail.python.org/mailman/listinfo/code-quality>`_
  66. Contributing
  67. ------------
  68. Issues are tracked on `GitHub <https://github.com/PyCQA/pyflakes/issues>`_.
  69. Patches may be submitted via a `GitHub pull request`_ or via the mailing list
  70. if you prefer. If you are comfortable doing so, please `rebase your changes`_
  71. so they may be applied to master with a fast-forward merge, and each commit is
  72. a coherent unit of work with a well-written log message. If you are not
  73. comfortable with this rebase workflow, the project maintainers will be happy to
  74. rebase your commits for you.
  75. All changes should include tests and pass flake8_.
  76. .. image:: https://github.com/PyCQA/pyflakes/workflows/Test/badge.svg
  77. :target: https://github.com/PyCQA/pyflakes/actions
  78. :alt: GitHub Actions build status
  79. .. _Pylint: https://pylint.pycqa.org/
  80. .. _flake8: https://pypi.org/project/flake8/
  81. .. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
  82. .. _`rebase your changes`: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
  83. .. _`GitHub pull request`: https://github.com/PyCQA/pyflakes/pulls
  84. Changelog
  85. ---------
  86. Please see `NEWS.rst <https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst>`_.