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: :: python
   9
  10 foobar(foo,
  11        bar)
  12
  13 and :: python
  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 well as I can,
  28 provided 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 with a say in this
  33 objects, please let me know.
  34
  35 Installation
  36 ------------
  37
  38 Pathogen
  39 ########
  40 Follow the instructions on installing Pathogen_ and then ::
  41
  42 cd ~/.vim/bundle
  43 git clone https://github.com/hynek/vim-python-pep8-indent.git
  44
  45 Vundle
  46 ######
  47
  48 Follow the instructions on installing Vundle_ and add the appropriate
  49 plugin line: ::
  50
  51 Plugin 'hynek/vim-python-pep8-indent`
  52
  53 NeoBundle
  54 #########
  55
  56 Follow the instructions on installing NeoBundle_ and add the appropriate
  57 NeoBundle line: ::
  58
  59 NeoBundle 'hynek/vim-python-pep8-indent`
  60
  61 ### Notes
  62
  63 Please note that Kirill Klenov’s [python-mode][python_mode]ships its own version
  64 of this bundle.  Therefore, if you want to use this version specifically,
  65 you’ll have to disable python-mode’s using ::
  66
  67 let g:pymode_indent = 0
  68
  69 .. _vim: http://www.vim.org/
  70 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
  71 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
  72 .. _`Steve Losh`: http://stevelosh.com/
  73 .. _here: https://gist.github.com/2965846
  74 .. _Neobundle: https://github.com/Shougo/neobundle.vim
  75 .. _Pathogen: https://github.com/tpope/vim-pathogen
  76 .. _python-mode: https://github.com/klen/python-mode
  77 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
  78 .. _vundle: https://github.com/gmarik/Vundle.vim