##// END OF EJS Templates
Backport PR #12587: [Docs] Improve installing docs if on zsh
Matthias Bussonnier -
Show More
@@ -1,144 +1,144 b''
1 .. _install:
1 .. _install:
2
2
3 Installing IPython
3 Installing IPython
4 ==================
4 ==================
5
5
6
6
7 IPython 6 requires Python β‰₯ 3.3. IPython 5.x can be installed on Python 2.
7 IPython 6 requires Python β‰₯ 3.3. IPython 5.x can be installed on Python 2.
8
8
9
9
10 Quick Install
10 Quick Install
11 -------------
11 -------------
12
12
13 With ``pip`` already installed :
13 With ``pip`` already installed :
14
14
15 .. code-block:: bash
15 .. code-block:: bash
16
16
17 $ pip install ipython
17 $ pip install ipython
18
18
19 This installs IPython as well as its dependencies.
19 This installs IPython as well as its dependencies.
20
20
21 If you want to use IPython with notebooks or the Qt console, you should also
21 If you want to use IPython with notebooks or the Qt console, you should also
22 install Jupyter ``pip install jupyter``.
22 install Jupyter ``pip install jupyter``.
23
23
24
24
25
25
26 Overview
26 Overview
27 --------
27 --------
28
28
29 This document describes in detail the steps required to install IPython. For a
29 This document describes in detail the steps required to install IPython. For a
30 few quick ways to get started with package managers or full Python
30 few quick ways to get started with package managers or full Python
31 distributions, see `the install page <https://ipython.org/install.html>`_ of the
31 distributions, see `the install page <https://ipython.org/install.html>`_ of the
32 IPython website.
32 IPython website.
33
33
34 Please let us know if you have problems installing IPython or any of its
34 Please let us know if you have problems installing IPython or any of its
35 dependencies.
35 dependencies.
36
36
37 IPython and most dependencies should be installed via :command:`pip`.
37 IPython and most dependencies should be installed via :command:`pip`.
38 In many scenarios, this is the simplest method of installing Python packages.
38 In many scenarios, this is the simplest method of installing Python packages.
39 More information about :mod:`pip` can be found on
39 More information about :mod:`pip` can be found on
40 `its PyPI page <https://pip.pypa.io>`__.
40 `its PyPI page <https://pip.pypa.io>`__.
41
41
42
42
43 More general information about installing Python packages can be found in
43 More general information about installing Python packages can be found in
44 `Python's documentation <http://docs.python.org>`_.
44 `Python's documentation <http://docs.python.org>`_.
45
45
46 .. _dependencies:
46 .. _dependencies:
47
47
48 Dependencies
48 Dependencies
49 ~~~~~~~~~~~~
49 ~~~~~~~~~~~~
50
50
51 IPython relies on a number of other Python packages. Installing using a package
51 IPython relies on a number of other Python packages. Installing using a package
52 manager like pip or conda will ensure the necessary packages are installed.
52 manager like pip or conda will ensure the necessary packages are installed.
53 Manual installation without dependencies is possible, but not recommended.
53 Manual installation without dependencies is possible, but not recommended.
54 The dependencies can be viewed with package manager commands,
54 The dependencies can be viewed with package manager commands,
55 such as :command:`pip show ipython` or :command:`conda info ipython`.
55 such as :command:`pip show ipython` or :command:`conda info ipython`.
56
56
57
57
58 Installing IPython itself
58 Installing IPython itself
59 ~~~~~~~~~~~~~~~~~~~~~~~~~
59 ~~~~~~~~~~~~~~~~~~~~~~~~~
60
60
61 IPython requires several dependencies to work correctly, it is not recommended
61 IPython requires several dependencies to work correctly, it is not recommended
62 to install IPython and all its dependencies manually as this can be quite long
62 to install IPython and all its dependencies manually as this can be quite long
63 and troublesome. You should use the python package manager ``pip``.
63 and troublesome. You should use the python package manager ``pip``.
64
64
65 Installation using pip
65 Installation using pip
66 ~~~~~~~~~~~~~~~~~~~~~~
66 ~~~~~~~~~~~~~~~~~~~~~~
67
67
68 Make sure you have the latest version of :mod:`pip` (the Python package
68 Make sure you have the latest version of :mod:`pip` (the Python package
69 manager) installed. If you do not, head to `Pip documentation
69 manager) installed. If you do not, head to `Pip documentation
70 <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first.
70 <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first.
71
71
72 The quickest way to get up and running with IPython is to install it with pip:
72 The quickest way to get up and running with IPython is to install it with pip:
73
73
74 .. code-block:: bash
74 .. code-block:: bash
75
75
76 $ pip install ipython
76 $ pip install ipython
77
77
78 That's it.
78 That's it.
79
79
80
80
81 Installation from source
81 Installation from source
82 ~~~~~~~~~~~~~~~~~~~~~~~~
82 ~~~~~~~~~~~~~~~~~~~~~~~~
83
83
84 To install IPython from source,
84 To install IPython from source,
85 grab the latest stable tarball of IPython `from PyPI
85 grab the latest stable tarball of IPython `from PyPI
86 <https://pypi.python.org/pypi/ipython>`__. Then do the following:
86 <https://pypi.python.org/pypi/ipython>`__. Then do the following:
87
87
88 .. code-block:: bash
88 .. code-block:: bash
89
89
90 tar -xzf ipython-5.1.0.tar.gz
90 tar -xzf ipython-5.1.0.tar.gz
91 cd ipython-5.1.0
91 cd ipython-5.1.0
92 # The [test] extra ensures test dependencies are installed too:
92 # The [test] extra ensures test dependencies are installed too:
93 pip install .[test]
93 pip install '.[test]'
94
94
95 Do not invoke ``setup.py`` directly as this can have undesirable consequences
95 Do not invoke ``setup.py`` directly as this can have undesirable consequences
96 for further upgrades. We do not recommend using ``easy_install`` either.
96 for further upgrades. We do not recommend using ``easy_install`` either.
97
97
98 If you are installing to a location (like ``/usr/local``) that requires higher
98 If you are installing to a location (like ``/usr/local``) that requires higher
99 permissions, you may need to run the last command with :command:`sudo`. You can
99 permissions, you may need to run the last command with :command:`sudo`. You can
100 also install in user specific location by using the ``--user`` flag in
100 also install in user specific location by using the ``--user`` flag in
101 conjunction with pip.
101 conjunction with pip.
102
102
103 To run IPython's test suite, use the :command:`iptest` command from outside of
103 To run IPython's test suite, use the :command:`iptest` command from outside of
104 the IPython source tree:
104 the IPython source tree:
105
105
106 .. code-block:: bash
106 .. code-block:: bash
107
107
108 $ iptest
108 $ iptest
109
109
110 .. _devinstall:
110 .. _devinstall:
111
111
112 Installing the development version
112 Installing the development version
113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114
114
115 It is also possible to install the development version of IPython from our
115 It is also possible to install the development version of IPython from our
116 `Git <http://git-scm.com/>`_ source code repository. To do this you will
116 `Git <http://git-scm.com/>`_ source code repository. To do this you will
117 need to have Git installed on your system.
117 need to have Git installed on your system.
118
118
119
119
120 Then do:
120 Then do:
121
121
122 .. code-block:: bash
122 .. code-block:: bash
123
123
124 $ git clone https://github.com/ipython/ipython.git
124 $ git clone https://github.com/ipython/ipython.git
125 $ cd ipython
125 $ cd ipython
126 $ pip install -e .[test]
126 $ pip install -e '.[test]'
127
127
128 The :command:`pip install -e .` command allows users and developers to follow
128 The :command:`pip install -e .` command allows users and developers to follow
129 the development branch as it changes by creating links in the right places and
129 the development branch as it changes by creating links in the right places and
130 installing the command line scripts to the appropriate locations.
130 installing the command line scripts to the appropriate locations.
131
131
132 Then, if you want to update your IPython at any time, do:
132 Then, if you want to update your IPython at any time, do:
133
133
134 .. code-block:: bash
134 .. code-block:: bash
135
135
136 $ git pull
136 $ git pull
137
137
138 If the dependencies or entrypoints have changed, you may have to run
138 If the dependencies or entrypoints have changed, you may have to run
139
139
140 .. code-block:: bash
140 .. code-block:: bash
141
141
142 $ pip install -e .
142 $ pip install -e .
143
143
144 again, but this is infrequent.
144 again, but this is infrequent.
General Comments 0
You need to be logged in to leave comments. Login now