Ravenports generated: 02 Jul 2018 06:37
[ravenports.git] / bucket_0A / python-pycodestyle
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-pycodestyle
4 VERSION=                2.4.0
5 KEYWORDS=               python devel
6 VARIANTS=               py27 py36 py37
7 SDESC[py36]=            Python style guide checker (PY 36)
8 SDESC[py37]=            Python style guide checker (PY 37)
9 SDESC[py27]=            Python style guide checker (PY 27)
10 HOMEPAGE=               https://pycodestyle.readthedocs.io/
11 CONTACT=                Python_Automaton[python@ironwolf.systems]
12
13 DOWNLOAD_GROUPS=        main
14 SITES[main]=            PYPI/p/pycodestyle
15 DISTFILE[1]=            pycodestyle-2.4.0.tar.gz:main
16 DF_INDEX=               1
17 SPKGS[py36]=            single
18 SPKGS[py37]=            single
19 SPKGS[py27]=            single
20
21 OPTIONS_AVAILABLE=      PY27 PY36 PY37
22 OPTIONS_STANDARD=       none
23 VOPTS[py36]=            PY27=OFF PY36=ON PY37=OFF
24 VOPTS[py37]=            PY27=OFF PY36=OFF PY37=ON
25 VOPTS[py27]=            PY27=ON PY36=OFF PY37=OFF
26
27 DISTNAME=               pycodestyle-2.4.0
28
29 GENERATED=              yes
30
31 [PY36].USES_ON=                         python:py36
32
33 [PY37].USES_ON=                         python:py37
34
35 [PY27].USES_ON=                         python:py27
36
37 [FILE:3458:descriptions/desc.single]
38 pycodestyle (formerly called pep8) - Python style guide checker
39 ===============================================================
40
41 .. image:: https://img.shields.io/travis/PyCQA/pycodestyle.svg
42    :target: https://travis-ci.org/PyCQA/pycodestyle
43    :alt: Build status
44
45 .. image::
46 https://readthedocs.org/projects/pycodestyle/badge/?version=latest
47     :target: https://pycodestyle.readthedocs.io
48     :alt: Documentation Status
49
50 .. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg
51    :target: https://pypi.python.org/pypi/pycodestyle
52    :alt: Wheel Status
53
54 .. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg
55    :alt: Join the chat at https://gitter.im/PyCQA/pycodestyle
56    :target:
57 https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_c
58 ampaign=pr-badge&utm_content=badge
59
60 pycodestyle is a tool to check your Python code against some of the style
61 conventions in `PEP 8`_.
62
63 .. _PEP 8: http://www.python.org/dev/peps/pep-0008/
64
65 .. note::
66
67     This package used to be called ``pep8`` but was renamed to
68 ``pycodestyle``
69     to reduce confusion. Further discussion can be found `in the issue
70 where
71     Guido requested this
72     change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the
73     lightning talk at PyCon 2016 by @IanLee1521:
74     `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_
75     `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.
76
77 Features
78 --------
79
80 * Plugin architecture: Adding new checks is easy.
81
82 * Parseable output: Jump to error location in your editor.
83
84 * Small: Just one Python file, requires only stdlib. You can use just
85   the ``pycodestyle.py`` file for this purpose.
86
87 * Comes with a comprehensive test suite.
88
89 Installation
90 ------------
91
92 You can install, upgrade, and uninstall ``pycodestyle.py`` with these
93 commands::
94
95   $ pip install pycodestyle
96   $ pip install --upgrade pycodestyle
97   $ pip uninstall pycodestyle
98
99 There's also a package for Debian/Ubuntu, but it's not always the
100 latest version.
101
102 Example usage and output
103 ------------------------
104
105 ::
106
107   $ pycodestyle --first optparse.py
108   optparse.py:69:11: E401 multiple imports on one line
109   optparse.py:77:1: E302 expected 2 blank lines, found 1
110   optparse.py:88:5: E301 expected 1 blank line, found 0
111   optparse.py:222:34: W602 deprecated form of raising exception
112   optparse.py:347:31: E211 whitespace before '('
113   optparse.py:357:17: E201 whitespace after '{'
114   optparse.py:472:29: E221 multiple spaces before operator
115   optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
116
117 You can also make ``pycodestyle.py`` show the source code for each error,
118 and
119 even the relevant text from PEP 8::
120
121   $ pycodestyle --show-source --show-pep8 testsuite/E40.py
122   testsuite/E40.py:2:10: E401 multiple imports on one line
123   import os, sys
124            ^
125       Imports should usually be on separate lines.
126
127       Okay: import os\nimport sys
128       E401: import sys, os
129
130
131 Or you can display how often each error was found::
132
133   $ pycodestyle --statistics -qq Python-2.5/Lib
134   232     E201 whitespace after '['
135   599     E202 whitespace before ')'
136   631     E203 whitespace before ','
137   842     E211 whitespace before '('
138   2531    E221 multiple spaces before operator
139   4473    E301 expected 1 blank line, found 0
140   4006    E302 expected 2 blank lines, found 1
141   165     E303 too many blank lines (4)
142   325     E401 multiple imports on one line
143   3615    E501 line too long (82 characters)
144   612     W601 .has_key() is deprecated, use 'in'
145
146
147 [FILE:103:distinfo]
148 cbfca99bd594a10f674d0cd97a3d802a1fdef635d4361e1a2658de47ed261e3a        96665 pycodestyle-2.4.0.tar.gz
149