README.rst

   1 vim-python-pep8-indent
   2 ======================
   3
   4 .. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis
   5    :target: https://travis-ci.org/hynek/vim-python-pep8-indent
   6
   7 This small script modifies vim_’s indentation behavior to comply with PEP8_ and
   8 my aesthetic preferences: ::
   9
  10    foobar(foo,
  11           bar)
  12
  13 and ::
  14
  15    foobar(
  16       foo,
  17       bar
  18    )
  19
  20 It was *not* originally written by me. I have found the script in vim’s `script
  21 repo`_, however the indentation was off by one character in the first case.
  22
  23 I fixed it with the help of `Steve Losh`_ and am putting it out here so you
  24 don’t have to patch the original. The original patch is still available here_.
  25
  26 While my Vimscript_ skills are still feeble, I intend to maintain it for now.
  27 So feel free to report bugs, I’ll try to address them as good as possible if
  28 they fit into the scope of this project.
  29
  30 Unfortunately, I wasn’t able to reach any of the original authors/maintainers:
  31 **David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their
  32 work and release it hereby to the *Public Domain*. If anyone – who has a say in
  33 this – objects, please let me know.
  34
  35 Installation
  36 ------------
  37
  38 The easiest way is to use pathogen_ and do a ::
  39
  40    git clone https://github.com/hynek/vim-python-pep8-indent.git
  41
  42 in your `~/.vim/bundle`. And you *should* use pathogen. Really.
  43
  44 Please note that Kirill Klenov’s python-mode_ ships an own version of of this
  45 bundle.  Therefore, if you want to use this version specifically, you’ll have
  46 to disable python-mode’s using: ::
  47
  48    let g:pymode_indent = 0
  49
  50 .. _vim: http://www.vim.org/
  51 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
  52 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
  53 .. _`Steve Losh`: http://stevelosh.com/
  54 .. _here: https://gist.github.com/2965846
  55 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
  56 .. _pathogen: https://github.com/tpope/vim-pathogen
  57 .. _python-mode: https://github.com/klen/python-mode