Giter Club home page Giter Club logo

jedi's Introduction

Jedi - an awesome autocompletion library for Python

Travis-CI build status

Coverage Status

Number of PyPI downloads

Latest PyPI version

Jedi is an autocompletion tool for Python that can be used in IDEs/editors. Jedi works. Jedi is fast. It understands all of the basic Python syntax elements including many builtin functions.

Additionaly, Jedi suports two different goto functions and has support for renaming as well as Pydoc support and some other IDE features.

Jedi uses a very simple API to connect with IDE's. There's a reference implementation as a VIM-Plugin, which uses Jedi's autocompletion. I encourage you to use Jedi in your IDEs. It's really easy. If there are any problems (also with licensing), just contact me.

Jedi can be used with the following editors:

And it powers the following projects:

  • wdb - Web Debugger

Here are some pictures:

image

Completion for almost anything (Ctrl+Space).

image

Display of function/class bodies, docstrings.

image

Pydoc support (with highlighting, Shift+k).

There is also support for goto and renaming.

Get the latest version from github (master branch should always be kind of stable/working).

Docs are available at https://jedi.jedidjah.ch/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome. Jedi uses semantic versioning.

Installation

pip install jedi

Note: This just installs the Jedi library, not the editor plugins. For information about how to make it work with your editor, refer to the corresponding documentation.

You don't want to use pip? Please refer to the manual.

Feature Support and Caveats

Jedi really understands your Python code. For a comprehensive list what Jedi can do, see: Features. A list of caveats can be found on the same page.

You can run Jedi on cPython 2.6, 2.7, 3.2 or 3.3, but it should also understand/parse code older than those versions.

Tips on how to use Jedi efficiently can be found here.

API for IDEs

It's very easy to create an editor plugin that uses Jedi. See Plugin API for more information.

If you have specific questions, please add an issue or ask on stackoverflow with the label python-jedi.

Development

There's a pretty good and extensive development documentation.

Testing

The test suite depends on tox and pytest:

pip install tox pytest

To run the tests for all supported Python versions:

tox

If you want to test only a specific Python version (e.g. Python 2.7), it's as easy as :

tox -e py27

Tests are also run automatically on Travis CI.

For more detailed information visit the testing documentation

jedi's People

Contributors

davidhalter avatar tkf avatar dbrgn avatar lvh avatar colinduquesnoy avatar asmeurer avatar hattya avatar astrac avatar jkb0o avatar blink1073 avatar andviro avatar blueyed avatar jorgenschaefer avatar floppym avatar fbergroth avatar mfussenegger avatar pombredanne avatar syohex avatar srusskih avatar

Watchers

Grzegorz Rygielski avatar James Cloos 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.