Giter Club home page Giter Club logo

jedi-vim's Introduction

jedi-vim - awesome Python autocompletion with VIM

now in beta testing phase

If you have any comments or feature requests, please tell me! I really want to know, what you think about Jedi and jedi-vim.

jedi-vim is a is a VIM binding to the awesome autocompletion library Jedi.

Here are some pictures:

https://github.com/davidhalter/jedi/raw/master/screenshot_complete.png

Completion for almost anything (Ctrl+Space).

https://github.com/davidhalter/jedi/raw/master/screenshot_function.png

Display of function/class bodies, docstrings.

https://github.com/davidhalter/jedi/raw/master/screenshot_pydoc.png

Pydoc support (with highlighting, Shift+k).

There is also support for goto and renaming.

Get the latest from github.

You can get the Jedi library is documented here.

Support

The Jedi library supports most of Python's core features. From decorators to generators, there is broad support.

Installation

You might want to use pathogen to install jedi in VIM. Also you need a VIM version that was compiled with +python, which is typical for most distributions on Linux.

The first thing you need after that is an up-to-date version of Jedi. You can either get it via pip install jedi or with git submodule update --init in your jedi-vim repository.

The autocompletion can be used with <ctrl+space>, if you want it to work with <tab> you can use supertab.

Options

Jedi is by default automatically initialized. If you don't want that I suggest you disable the auto-initialization in your .vimrc:

let g:jedi#auto_initialization = 0

The goto is by default on <leader g>. If you want to change that:

let g:jedi#goto_command = "<leader>g"

get_definition is by default on <leader d>. If you want to change that:

let g:jedi#get_definition_command = "<leader>d"

Showing the pydoc is by default on K If you want to change that:

let g:jedi#pydoc = "K"

If you are a person who likes to use VIM-buffers not tabs, you might want to put that in your .vimrc:

let g:jedi#use_tabs_not_buffers = 0

Jedi automatically starts the completion, if you type a dot, e.g. str., if you don't want this:

let g:jedi#popup_on_dot = 0

There's some support for refactoring:

let g:jedi#rename_command = "<leader>r"

And you can list all names that are related (have the same origin):

let g:jedi#related_names_command = "<leader>n"

jedi-vim's People

Contributors

davidhalter avatar strycore avatar nwgh avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.