Jedi - an awesome autocompletion, static analysis and refactoring library for Python
************************************************************************************

[image: GitHub stars][image][image: The percentage of open issues and
pull requests][image][image: The resolution time is the median time an
issue or pull request stays open.][image][image: Tests][image][image:
Coverage status][image][image: PyPI Downloads][image]

Github Repository

Jedi is a static analysis tool for Python that is typically used in
IDEs/editors plugins. Jedi has a focus on autocompletion and goto
functionality. Other features include refactoring, code search and
finding references.

Jedi has a simple API to work with. There is a reference
implementation as a VIM-Plugin. Autocompletion in your REPL is also
possible, IPython uses it natively and for the CPython REPL you can
install it. Jedi is well tested and bugs should be rare.

Here's a simple example of the autocompletion feature:

>>> import jedi
>>> source = '''
... import json
... json.lo'''
>>> script = jedi.Script(source, path='example.py')
>>> script
<Script: 'example.py' ...>
>>> completions = script.complete(3, len('json.lo'))
>>> completions
[<Completion: load>, <Completion: loads>]
>>> print(completions[0].complete)
ad
>>> print(completions[0].name)
load

Autocompletion can for example look like this in jedi-vim:

   [image]


Docs
====

* Using Jedi

* Features and Limitations

* API Overview

* API Return Classes

* Installation and Configuration

* Settings

* Jedi Development

* Jedi Testing

* History & Acknowledgements

* Changelog


Resources
=========

If you want to stay **up-to-date** with releases, please **subscribe**
to this mailing list: https://groups.google.com/g/jedi-announce. To
subscribe you can simply send an empty email to "jedi-
announce+subscribe@googlegroups.com".

* Source Code on Github

* Python Package Index
