| single |
####################################################################################
Jedi - an awesome autocompletion, static analysis and refactoring library
for Python
####################################################################################
:alt: The percentage of open issues and pull requests
:alt: The resolution time is the median time an issue or pull request
stays open.
:alt: Linux Tests
:alt: Windows Tests
:alt: Coverage status
:alt: PyPI Downloads
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.
Jedi can currently be used with the following editors/projects:
- Vim (jedi-vim_, YouCompleteMe_, deoplete-jedi_, completor.vim_)
- `Visual Studio Code`_ (via [Python Extension])
- Emacs (Jedi.el_, company-mode_, elpy_, anaconda-mode_, ycmd_)
- Sublime Text (SublimeJEDI_ [ST2 + ST3], anaconda_ [only ST3])
- TextMate_ (Not sure if it's actually working)
- Kate_ version 4.13+ supports it natively, you have to enable it, though.
[[see
]]
- Atom_ (autocomplete-python-jedi_)
- `GNOME Builder`_ (with support for GObject Introspection)
- Gedit (gedi_)
- wdb_ - Web Debugger
- `Eric IDE`_ (Available as a plugin)
- `IPython 6.0.0+
`_
and many more!
Here are some pictures taken from jedi-vim_:
.. image::
https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png
Completion for almost anything:
.. image::
https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png
Documentation:
.. image::
https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png
Get the latest version from [github]
(master branch should always be kind of stable/working).
Docs are available at `https://jedi.readthedocs.org/en/latest/
`_. Pull requests with
enhancements
and/or fixes are awesome and most welcome. Jedi uses [semantic versioning
].
If you want to stay up-to-date (News / RFCs), please subscribe to this
[github
thread].:
Issues & Questions
==================
You can file issues and questions in the [issue tracker
]. Alternatively you can also ask on
[Stack Overflow] with
the label ``python-jedi``.
Installation
============
[Check out the docs].
Features and Limitations
========================
Jedi's features are listed here:
[Features].
You can run Jedi on CPython 2.7 or 3.5+ but it should also
understand code that is older than those versions. Additionally you should
|