Installation and Configuration¶
Warning
Most people will want to install Jedi as a submodule/vendored and not through pip/system wide. The reason for this is that it makes sense that the plugin that uses Jedi has always access to it. Otherwise Jedi will not work properly when virtualenvs are activated. So please read the documentation of your editor/IDE plugin to install Jedi.
For plugin developers, Jedi works best if it is always available. Vendoring is a pretty good option for that.
You can either include Jedi as a submodule in your text editor plugin (like jedi-vim does by default), or you can install it systemwide.
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.
The normal way¶
Most people use Jedi with a editor plugins. Typically you install Jedi by installing an editor plugin. No necessary steps are needed. Just take a look at the instructions for the plugin.
With pip¶
On any system you can install Jedi directly from the Python package index using pip:
sudo pip install jedi
If you want to install the current development version (master branch):
sudo pip install -e git://github.com/davidhalter/jedi.git#egg=jedi
System-wide installation via a package manager¶
Arch Linux¶
You can install Jedi directly from official Arch Linux packages:
(There is also a packaged version of the vim plugin available: vim-jedi at Arch Linux.)
Debian¶
Debian packages are available in the unstable repository.
Others¶
We are in the discussion of adding Jedi to the Fedora repositories.
Manual installation from GitHub¶
If you prefer not to use an automated package installer, you can clone the source from GitHub and install it manually. To install it, run these commands:
git clone --recurse-submodules https://github.com/davidhalter/jedi
cd jedi
sudo python setup.py install