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