/python-mode

Vim python-mode. PyLint, Rope, Pydoc, breakpoints from box.

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

logo Python-mode, Python in VIM

https://travis-ci.org/klen/python-mode.png?branch=develop

The project needs maintainers and contributors

Actually, I have no time for support the project, so if you feel yourself as strong don't be hesitate to contact me.



Src: https://github.com/klen/python-mode
Homepage: https://klen.github.io/python-mode/
Docs: https://github.com/klen/python-mode/blob/develop/doc/pymode.txt

Python-mode is a vim plugin that helps you to create python code very quickly by utilizing libraries including pylint, rope, pydoc, pyflakes, pep8, autopep8, pep257 and mccabe for features like static analysis, refactoring, folding, completion, documentation, and more.

The plugin contains all you need to develop python applications in Vim.

There is no need to install pylint, rope or any other Python Libraries on your system.

  • Support Python version 2.6+ and 3.2+
  • Syntax highlighting
  • Virtualenv support
  • Run python code (<leader>r)
  • Add/remove breakpoints (<leader>b)
  • Improved Python indentation
  • Python folding
  • Python motions and operators (]], 3[[, ]]M, vaC, viM, daC, ciM, ...)
  • Code checking (pylint, pyflakes, pylama, ...) that can be run simultaneously (:PymodeLint)
  • Autofix PEP8 errors (:PymodeLintAuto)
  • Search in python documentation (K)
  • Code refactoring <rope refactoring library> (rope)
  • Strong code completion (rope)
  • Go to definition (<C-c>g for :RopeGotoDefinition)
  • And more, more ...

See (very old) screencast here: http://www.youtube.com/watch?v=67OZNp9Z0CQ (sorry for quality, this is my first screencast) Another old presentation here: http://www.youtube.com/watch?v=YhqsjUUHj6g

To read python-mode documentation in Vim, see :help pymode

  • VIM >= 7.3 (mostly features needed +python or +python3 support) (also --with-features=big if you want g:pymode_lint_signs)
% cd ~/.vim
% mkdir -p bundle && cd bundle
% git clone https://github.com/klen/python-mode.git
  • Enable pathogen in your ~/.vimrc:

    " Pathogen load
    filetype off
    
    call pathogen#infect()
    call pathogen#helptags()
    
    filetype plugin indent on
    syntax on
    
% git clone https://github.com/klen/python-mode.git
% cd python-mode
% cp -R * ~/.vim

Then rebuild helptags in vim:

:helptags ~/.vim/doc/

Note

filetype-plugin (:help filetype-plugin-on) and filetype-indent (:help filetype-indent-on) must be enabled to use python-mode.

|Repository URL: https://klen.github.io/python-mode/deb/

Install with commands:

add-apt-repository https://klen.github.io/python-mode/deb main
apt-get update
apt-get install vim-python-mode

If you are getting the message: "The following signatures couldn't be verified because the public key is not available":

apt-key adv --keyserver keyserver.ubuntu.com --recv-keys B5DF65307000E266

vim-python-mode using vim-addons, so after installation just enable python-mode with command:

vim-addons install python-mode

If your python-mode doesn't work:

  1. Load Vim with only python-mode enabled (use debug.vim from pymode):

    vim -u <path_to_pymode>/debug.vim
    

And try to repeat your case. If no error occurs, seems like problem isn't in the plugin.

  1. Type :PymodeTroubleshooting

And fix any warnings or copy the output and send it to me. (For example, by creating a new github issue if one does not already exist for the problem).

You can override the default key bindings by redefining them in your .vimrc, for example:

" Override go-to.definition key shortcut to Ctrl-]
let g:pymode_rope_goto_definition_bind = "<C-]>"

" Override run current python file key shortcut to Ctrl-Shift-e
let g:pymode_run_bind = "<C-S-e>"

" Override view python doc key shortcut to Ctrl-Shift-d
let g:pymode_doc_bind = "<C-S-d>"

Documentation is available in your vim :help pymode

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/python-mode/issues

See the AUTHORS file.

Development of python-mode happens at github: https://github.com/klen/python-mode

Please make a pull request to development branch and add yourself to AUTHORS.

Vendored Python modules are located mostly in pymode/libs/.

PyPI: https://pypi.python.org/pypi/rope
Src: https://github.com/python-rope/rope
Docs: https://github.com/python-rope/rope/blob/master/docs/overview.rst
Docs: https://github.com/python-rope/rope/blob/master/docs/library.rst
PyPI: https://pypi.python.org/pypi/ropemode
Src: https://github.com/python-rope/ropemode
PyPI: https://pypi.python.org/pypi/ropevim
Src: https://github.com/python-rope/ropevim
Docs: https://github.com/python-rope/ropevim/blob/master/doc/ropevim.txt
PyPI: https://pypi.python.org/pypi/pylama
Src: https://github.com/klen/pylama
PyPI: https://pypi.python.org/pypi/pylint
Src: https://bitbucket.org/logilab/pylint
Homepage: http://www.pylint.org/
Docs: http://docs.pylint.org/
Docs: http://docs.pylint.org/message-control.html
Docs: http://docs.pylint.org/faq.html#message-control
ErrCodes: http://pylint-messages.wikidot.com/all-codes
ErrCodes: http://pylint-messages.wikidot.com/all-messages
PyPI: https://pypi.python.org/pypi/pyflakes
Src: https://github.com/pyflakes/pyflakes
ErrCodes: https://flake8.readthedocs.org/en/latest/warnings.html
PyPI: https://pypi.python.org/pypi/pep8
Src: http://github.com/jcrocholl/pep8
PEP 8: http://www.python.org/dev/peps/pep-0008/
PEP 8: http://legacy.python.org/dev/peps/pep-0008/
Docs: https://pep8.readthedocs.org/en/latest/
Docs: https://pep8.readthedocs.org/en/latest/intro.html#configuration
ErrCodes: https://pep8.readthedocs.org/en/latest/intro.html#error-codes
PyPI: https://pypi.python.org/pypi/autopep8
Src: https://github.com/hhatto/autopep8
PyPI: https://pypi.python.org/pypi/pep257
Src: http://github.com/GreenSteam/pep257
Docs: https://pep257.readthedocs.org/en/latest/
PEP 257: http://www.python.org/dev/peps/pep-0257/
ErrCodes: https://pep257.readthedocs.org/en/latest/error_codes.html
PyPI: https://pypi.python.org/pypi/mccabe
Src: https://github.com/flintwork/mccabe
Docs: https://en.wikipedia.org/wiki/Cyclomatic_complexity

Vendored Vim modules are located mostly in t/.

Src: http://www.hlabs.spb.ru/vim/python.vim
Src: http://github.com/hynek/vim-python-pep8-indent

Copyright © 2013-2015 Kirill Klenov (klen)

Licensed under a GNU lesser general public license.

If you like this plugin, I would very appreciated if you kindly send me a postcard :) My address is here: "Russia, 143500, MO, Istra, pos. Severny 8-3" to "Kirill Klenov". Thanks for support!