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 my aesthetic preferences.
   8 Most importantly::
   9
  10    foobar(foo,
  11           bar)
  12
  13 and::
  14
  15    foobar(
  16       foo,
  17       bar
  18    )
  19
  20
  21 Installation
  22 ------------
  23
  24
  25 Pathogen
  26 ^^^^^^^^
  27
  28 Follow the instructions on installing Pathogen_ and then:
  29
  30 .. code-block:: shell-session
  31
  32    $ cd ~/.vim/bundle
  33    $ git clone https://github.com/hynek/vim-python-pep8-indent.git
  34
  35
  36 Vundle
  37 ^^^^^^
  38
  39 Follow the instructions on installing Vundle_ and add the appropriate plugin line into your ``.vimrc``:
  40
  41 .. code-block:: vim
  42
  43    Plugin 'hynek/vim-python-pep8-indent'
  44
  45
  46 NeoBundle
  47 ^^^^^^^^^
  48
  49 Follow the instructions on installing NeoBundle_ and add the appropriate NeoBundle line into your ``.vimrc``:
  50
  51 .. code-block:: vim
  52
  53    NeoBundle 'hynek/vim-python-pep8-indent'
  54
  55
  56 Notes
  57 -----
  58
  59 Please note that Kirill Klenov’s python-mode_ ships its own version of this bundle.
  60 Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using:
  61
  62 .. code-block:: vim
  63
  64    let g:pymode_indent = 0
  65
  66
  67 License and Authorship
  68 ----------------------
  69
  70 This script is based on one from Vim’s official `script repo`_  that was *not* originally written by me.
  71 Unfortunately the indentation was off by one character in one case and the script hasn’t been updated since 2005.
  72
  73 Even more unfortunately, I wasn’t able to reach any of the original authors/maintainers:
  74 **David Bustos** and **Eric Mc Sween**.
  75
  76 So I fixed the annoyance with the help of `Steve Losh`_ and am putting it out here so you don’t have to patch the original yourself.
  77 The original patch is still available here_.
  78
  79 Over the time a lot more improvements have been contributed_ by `generous people`_.
  80
  81 I’d like to thank the original authors here for their work and release it hereby to the *Public Domain* (using the CC0_ licence) since I hope that would be in their spirit.
  82 If anyone with a say in this objects, please let me_ know immediately.
  83 Also, if someone is in contact with one of them, I would appreciate being introduced.
  84
  85 While my Vimscript_ skills are still feeble, I intend to maintain it for now.
  86 This mainly means that I’ll triage through bugs and pull requests but won’t be fixing much myself.
  87
  88
  89 .. _Vim: http://www.vim.org/
  90 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
  91 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
  92 .. _`Steve Losh`: http://stevelosh.com/
  93 .. _here: https://gist.github.com/2965846
  94 .. _Neobundle: https://github.com/Shougo/neobundle.vim
  95 .. _Pathogen: https://github.com/tpope/vim-pathogen
  96 .. _python-mode: https://github.com/klen/python-mode
  97 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
  98 .. _vundle: https://github.com/gmarik/Vundle.vim
  99 .. _me: https://hynek.me/
 100 .. _CC0: http://creativecommons.org/publicdomain/zero/1.0/
 101 .. _contributed: https://github.com/hynek/vim-python-pep8-indent/blob/master/CONTRIBUTING.rst
 102 .. _`generous people`: https://github.com/hynek/vim-python-pep8-indent/graphs/contributors