bucket_48/python-yapf

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-yapf
   4 VERSION=                0.20.1
   5 KEYWORDS=               python devel
   6 VARIANTS=               py27 py35 py36
   7 SDESC[py35]=            Formatter for Python code. (PY 35)
   8 SDESC[py36]=            Formatter for Python code. (PY 36)
   9 SDESC[py27]=            Formatter for Python code. (PY 27)
  10 HOMEPAGE=               none
  11 CONTACT=                Python_Automaton[python@ironwolf.systems]
  12
  13 DOWNLOAD_GROUPS=        main
  14 SITES[main]=            PYPI/y/yapf
  15 DISTFILE[1]=            yapf-0.20.1.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=               yapf-0.20.1
  28
  29 LICENSE_SCHEME=         solo
  30
  31 GENERATED=              yes
  32
  33 [PY35].USES_ON=                         python:py35
  34
  35 [PY36].USES_ON=                         python:py36
  36
  37 [PY27].USES_ON=                         python:py27
  38
  39 [FILE:3042:descriptions/desc.single]
  40 ====
  41 YAPF
  42 ====
  43
  44 .. image:: https://badge.fury.io/py/yapf.svg
  45     :target: https://badge.fury.io/py/yapf
  46     :alt: PyPI version
  47
  48 .. image:: https://travis-ci.org/google/yapf.svg?branch=master
  49     :target: https://travis-ci.org/google/yapf
  50     :alt: Build status
  51
  52 .. image:: https://coveralls.io/repos/google/yapf/badge.svg?branch=master
  53     :target: https://coveralls.io/r/google/yapf?branch=master
  54     :alt: Coverage status
  55
  56
  57 Introduction
  58 ============
  59
  60 Most of the current formatters for Python --- e.g., autopep8, and pep8ify ---
  61 are made to remove lint errors from code. This has some obvious limitations.
  62 For instance, code that conforms to the PEP 8 guidelines may not be
  63 reformatted.  But it doesn't mean that the code looks good.
  64
  65 YAPF takes a different approach. It's based off of 'clang-format', developed by
  66 Daniel Jasper. In essence, the algorithm takes the code and reformats it to the
  67 best formatting that conforms to the style guide, even if the original code
  68 didn't violate the style guide. The idea is also similar to the 'gofmt' tool for
  69 the Go programming language: end all holy wars about formatting - if the whole
  70 codebase of a project is simply piped through YAPF whenever modifications are
  71 made, the style remains consistent throughout the project and there's no point
  72 arguing about style in every code review.
  73
  74 The ultimate goal is that the code YAPF produces is as good as the code that a
  75 programmer would write if they were following the style guide. It takes away
  76 some of the drudgery of maintaining your code.
  77
  78 Try out YAPF with this `online demo <https://yapf.herokuapp.com>`_.
  79
  80 .. footer::
  81
  82     YAPF is not an official Google product (experimental or otherwise), it is
  83     just code that happens to be owned by Google.
  84
  85 .. contents::
  86
  87
  88 Installation
  89 ============
  90
  91 To install YAPF from PyPI:
  92
  93 .. code-block::
  94
  95     $ pip install yapf
  96
  97 (optional) If you are using Python 2.7 and want to enable multiprocessing:
  98
  99 .. code-block::
 100
 101     $ pip install futures
 102
 103 YAPF is still considered in "alpha" stage, and the released version may change
 104 often; therefore, the best way to keep up-to-date with the latest development
 105 is to clone this repository.
 106
 107 Note that if you intend to use YAPF as a command-line tool rather than as a
 108 library, installation is not necessary. YAPF supports being run as a directory
 109 by the Python interpreter. If you cloned/unzipped YAPF into ``DIR``, it's
 110 possible to run:
 111
 112 .. code-block::
 113
 114     $ PYTHONPATH=DIR python DIR/yapf [options] ...
 115
 116
 117 Python versions
 118 ===============
 119
 120 YAPF supports Python 2.7 and 3.4.1+.
 121
 122 YAPF requires the code it formats to be valid Python for the version YAPF itself
 123 runs under. Therefore, if you format Python 3 code with YAPF, run YAPF itself
 124 under Python 3 (and similarly for Python 2).
 125
 126
 127 Usage
 128 =====
 129
 130 Options::
 131
 132     usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
 133                 [--style STYLE] [--style-help] [--no-local-style] [-p]
 134                 [-vv]
 135                 [files [files ...]]
 136
 137     Formatter for Python code.
 138
 139     positional arguments:
 140
 141
 142 [FILE:97:distinfo]
 143 bd19f246be7193ad2acdc04702b92315f1ae28d49c82f6671afdeefe9d32f468       127222 yapf-0.20.1.tar.gz
 144