1.. include:: ../global.rst
2
3Installation and Configuration
4==============================
5
6.. warning:: Most people will want to install Jedi as a submodule/vendored and
7   not through pip/system wide. The reason for this is that it makes sense that
8   the plugin that uses Jedi has always access to it. Otherwise Jedi will not
9   work properly when virtualenvs are activated. So please read the
10   documentation of your editor/IDE plugin to install Jedi.
11
12   For plugin developers, Jedi works best if it is always available. Vendoring
13   is a pretty good option for that.
14
15You can either include |jedi| as a submodule in your text editor plugin (like
16jedi-vim_ does by default), or you can install it systemwide.
17
18.. note:: This just installs the |jedi| library, not the :ref:`editor plugins
19    <editor-plugins>`. For information about how to make it work with your
20    editor, refer to the corresponding documentation.
21
22
23The normal way
24--------------
25
26Most people use Jedi with a :ref:`editor plugins<editor-plugins>`. Typically
27you install Jedi by installing an editor plugin. No necessary steps are needed.
28Just take a look at the instructions for the plugin.
29
30
31With pip
32--------
33
34On any system you can install |jedi| directly from the Python package index
35using pip::
36
37    sudo pip install jedi
38
39If you want to install the current development version (master branch)::
40
41    sudo pip install -e git://github.com/davidhalter/jedi.git#egg=jedi
42
43
44System-wide installation via a package manager
45----------------------------------------------
46
47Arch Linux
48~~~~~~~~~~
49
50You can install |jedi| directly from official Arch Linux packages:
51
52- `python-jedi <https://www.archlinux.org/packages/community/any/python-jedi/>`__
53
54(There is also a packaged version of the vim plugin available:
55`vim-jedi at Arch Linux <https://www.archlinux.org/packages/community/any/vim-jedi/>`__.)
56
57Debian
58~~~~~~
59
60Debian packages are available in the `unstable repository
61<https://packages.debian.org/search?keywords=python%20jedi>`__.
62
63Others
64~~~~~~
65
66We are in the discussion of adding |jedi| to the Fedora repositories.
67
68
69Manual installation from GitHub
70---------------------------------------------
71
72If 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::
73
74    git clone --recurse-submodules https://github.com/davidhalter/jedi
75    cd jedi
76    sudo python setup.py install
77
78Inclusion as a submodule
79------------------------
80
81If you use an editor plugin like jedi-vim_, you can simply include |jedi| as a
82git submodule of the plugin directory. Vim plugin managers like Vundle_ or
83Pathogen_ make it very easy to keep submodules up to date.
84
85
86.. _jedi-vim: https://github.com/davidhalter/jedi-vim
87.. _vundle: https://github.com/gmarik/vundle
88.. _pathogen: https://github.com/tpope/vim-pathogen
89