Repository files navigation

This project needs contributors.

Documentation:

• :help pymode
• https://github.com/python-mode/python-mode/wiki

Please use python-mode tag on Stackoverflow to ask questions:https://stackoverflow.com/questions/tagged/python-mode

Important: From 2017-11-19 onwards python-mode uses submodules instead ofhard coding 3rd party libraries into its codebase. Please issue the command:git submodule update --init --recursiveinside your python-mode folder.

If you are a new user please clone the repos using the recursive flag:git clone --recursive https://github.com/python-mode/python-mode

Python-mode is a Vim plugin that magically converts Vim into a Python IDE.

Why Python-mode?

1. Be more productive: Pymode saves time by bringing all the toolsnecessary for professional developers so that you can focus on biggerthings. It has been finely tuned based on decades of experience workingwith Vim and is constantly kept up to date.
2. Get smart assistance: Pymode knows all about your code. We use thebest-in-class intellisense code completion, on-the-fly error checking andquick-fixes; easy project navigation and much more.
3. Use the full power and capabilities of Vim: Unlike traditional IDEswhich can only provide a small subset of Vim functionalities, you can doeverything and anything that you can in Vim.
4. Modular structure: We attempt to create Python-mode with the sameprinciples of python: i.e. have a modular structure, so that as and whenbetter libraries evolve, we can provide you the best experience, whileabstracting the details so that you can get back to what you do best.
5. Written mostly in Python: 96.1% written in Python. Well, we love Python:)

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

• 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 motions and operators (]],3[[,]]M,vaC,viM,daC,ciM, ...)
• Improved Python folding
• Run multiple code checkers simultaneously (:PymodeLint)
• Autofix PEP8 errors (:PymodeLintAuto)
• Search in python documentation (<leader>K)
• Code refactoring
• Intellisense code-completion
• Go to definition (<C-c>g)
• And more, more ...

See a screencast here:http://www.youtube.com/watch?v=67OZNp9Z0CQAnother old presentation here:http://www.youtube.com/watch?v=YhqsjUUHj6g

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

Vim >= 7.3 (most features needed +python or +python3 support) (also--with-features=big if you wantg:pymode_lint_signs).

As of vim8 there is an officially supported way of adding plugins. See:tab help packages in vim for details.

cd ~/.vim/pack/foo/startgit clone https://github.com/python-mode/python-mode.gitcd python-modegit submodule update --init --recursive

cd ~/.vimmkdir -p bundle && cd bundlegit clone --recursive https://github.com/python-mode/python-mode.git

Enablepathogen in your~/.vimrc:

" Pathogen loadfiletype offcall pathogen#infect()call pathogen#helptags()filetype plugin indent onsyntax on

Include the following in thevim-plugsection of your~/.vimrc:

Plug 'python-mode/python-mode', { 'branch': 'develop' }

% git clone --recursive https://github.com/python-mode/python-mode.git% cd python-mode% cp -R * ~/.vim

Then rebuildhelptags in vim:

:helptags ~/.vim/doc/

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

First read our shortFAQor using:help pymode-faq.If your question is not described there then you already know what to do(because you read the first item of our FAQ :) ).

Nevertheless just a refresher on how to submit bugs:

(From the FAQ) Start python mode with:vim -i NONE -u <path_to_pymode>/debugvimrc.vimReproduce the error and submit your python mode debug file. You can check itslocation with:messages for something like:pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt.Please submit the entire content of the file along with a reasoning of why theplugin seems broken.

Do check for sensitive information in the file before submitting.

Read this section before opening an issue on the tracker.

By default python-mode uses python 2 syntax checking. To enable python 3 syntaxchecking (e.g. for async) add:

let g:pymode_python = 'python3'

To your vimrc or exrc file.

Documentation is available in your vim:help pymode.

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

The contributing guidelines for this plugin are outlined at:help pymode-development.

• Author: Kirill Klenov (https://github.com/klen)
• Maintainers:
  • Felipe Vieira (https://github.com/fmv1992)
  • Diego Rabatone Oliveira (https://github.com/diraol)

Also see the AUTHORS file.

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

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

Vendored Python modules are located mostly inpymode/libs/.

Copyright © 2013-2015 Kirill Klenov (https://github.com/klen).

Licensed under aGNU lesser general public license.

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