install.rst
132 lines
| 3.8 KiB
| text/x-rst
|
RstLexer
Matthias Bussonnier
|
r22588 | Installing IPython | ||
================== | ||||
Fernando Perez
|
r1753 | |||
MinRK
|
r4097 | |||
Matthias Bussonnier
|
r22588 | IPython requires Python 2.7 or ≥ 3.3. | ||
Min RK
|
r20524 | |||
Fernando Perez
|
r6602 | |||
Matthias Bussonnier
|
r22588 | Quick Install | ||
------------- | ||||
Brian Granger
|
r1729 | |||
Matthias Bussonnier
|
r22588 | With ``pip`` already installed : | ||
Brian Granger
|
r1729 | |||
Brian Granger
|
r2276 | .. code-block:: bash | ||
Thomas Kluyver
|
r21579 | $ pip install ipython | ||
Fernando Perez
|
r6602 | |||
Carol Willing
|
r22594 | This installs IPython as well as its dependencies. | ||
Brian Granger
|
r2277 | |||
Carol Willing
|
r22594 | If you want to use IPython with notebooks or the Qt console, you should also | ||
install Jupyter ``pip install jupyter``. | ||||
Brian Granger
|
r1729 | |||
MinRK
|
r12090 | |||
Overview | ||||
Matthias Bussonnier
|
r22588 | -------- | ||
MinRK
|
r12090 | |||
Thomas Kluyver
|
r21579 | This document describes in detail the steps required to install IPython. | ||
MinRK
|
r12090 | For a few quick ways to get started with package managers or full Python distributions, | ||
see `the install page <http://ipython.org/install.html>`_ of the IPython website. | ||||
Please let us know if you have problems installing IPython or any of its dependencies. | ||||
Matthias Bussonnier
|
r22588 | IPython and most dependencies should be installed via :command:`pip`. | ||
MinRK
|
r16708 | In many scenarios, this is the simplest method of installing Python packages. | ||
More information about :mod:`pip` can be found on | ||||
Matthias Bussonnier
|
r22588 | `its PyPI page <https://pip.pypa.io>`__. | ||
MinRK
|
r12090 | |||
More general information about installing Python packages can be found in | ||||
`Python's documentation <http://docs.python.org>`_. | ||||
Brian Granger
|
r1690 | Installing IPython itself | ||
Matthias Bussonnier
|
r22588 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
Brian Granger
|
r1690 | |||
Matthias Bussonnier
|
r22588 | IPython requires several dependencies to work correctly, it is not recommended | ||
Carol Willing
|
r22594 | to install IPython and all its dependencies manually as this can be quite long and troublesome. | ||
You should use the python package manager ``pip``. | ||||
Brian Granger
|
r1690 | |||
MinRK
|
r16708 | Installation using pip | ||
Matthias Bussonnier
|
r22588 | ~~~~~~~~~~~~~~~~~~~~~~ | ||
Carol Willing
|
r22594 | Make sure you have the latest version of :mod:`pip` (the Python package | ||
Matthias Bussonnier
|
r22588 | manager) installed. If you do not, head to `Pip documentation | ||
Carol Willing
|
r22594 | <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first. | ||
Brian Granger
|
r1690 | |||
Matthias Bussonnier
|
r22588 | The quickest way to get up and running with IPython is to install it with pip: | ||
Fernando Perez
|
r1753 | |||
Brian Granger
|
r2276 | .. code-block:: bash | ||
MinRK
|
r12090 | $ pip install ipython | ||
Brian Granger
|
r1690 | |||
That's it. | ||||
MinRK
|
r12090 | |||
Brian Granger
|
r1690 | Installation from source | ||
Matthias Bussonnier
|
r22588 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
Brian Granger
|
r1690 | |||
MinRK
|
r16708 | If you don't want to use :command:`pip`, or don't have it installed, | ||
Thomas Kluyver
|
r21579 | grab the latest stable tarball of IPython `from PyPI | ||
<https://pypi.python.org/pypi/ipython>`__. Then do the following: | ||||
Brian Granger
|
r2276 | |||
.. code-block:: bash | ||||
Brian Granger
|
r1690 | |||
Brian Granger
|
r2277 | $ tar -xzf ipython.tar.gz | ||
$ cd ipython | ||||
Matthias Bussonnier
|
r22180 | $ pip install . | ||
Fernando Perez
|
r1753 | |||
Matthias Bussonnier
|
r22588 | Do not invoke ``setup.py`` directly as this can have undesirable consequences for further upgrades. | ||
Try to also avoid any usage of ``easy_install`` that can have similar undesirable consequences. | ||||
Fernando Perez
|
r1753 | If you are installing to a location (like ``/usr/local``) that requires higher | ||
Matthias Bussonnier
|
r22588 | permissions, you may need to run the last command with :command:`sudo`. You can | ||
Carol Willing
|
r22594 | also install in user specific location by using the ``--user`` flag in conjunction with pip. | ||
Matthias Bussonnier
|
r22588 | |||
Carol Willing
|
r22594 | To run IPython's test suite, use the :command:`iptest` command from outside of the IPython source tree: | ||
Matthias Bussonnier
|
r22588 | |||
.. code-block:: bash | ||||
$ iptest | ||||
Brian Granger
|
r1690 | |||
Installing the development version | ||||
Matthias Bussonnier
|
r22588 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
Brian Granger
|
r1690 | |||
Fernando Perez
|
r1753 | It is also possible to install the development version of IPython from our | ||
MinRK
|
r3768 | `Git <http://git-scm.com/>`_ source code repository. To do this you will | ||
Min RK
|
r20524 | need to have Git installed on your system. Then do: | ||
Fernando Perez
|
r1753 | |||
Brian Granger
|
r2276 | .. code-block:: bash | ||
Matthias Bussonnier
|
r22180 | $ git clone https://github.com/ipython/ipython.git | ||
Brian Granger
|
r2277 | $ cd ipython | ||
Matthias Bussonnier
|
r22180 | $ pip install . | ||
Brian Granger
|
r1690 | |||
Matthias Bussonnier
|
r22588 | Some users want to be able to follow the development branch as it changes. | ||
With :mod:`pip` installed, you can replace the last step by: | ||||
Brian Granger
|
r2276 | |||
.. code-block:: bash | ||||
Brian Granger
|
r1690 | |||
Min RK
|
r20524 | $ pip install -e . | ||
Brian Granger
|
r1690 | |||
Fernando Perez
|
r1754 | This creates links in the right places and installs the command line script to | ||
Matthias Bussonnier
|
r22588 | the appropriate location. | ||
Nikolay Koldunov
|
r16317 | |||
Min RK
|
r20524 | Then, if you want to update your IPython at any time, do: | ||
Brian Granger
|
r2276 | |||
.. code-block:: bash | ||||
Fernando Perez
|
r1753 | |||
MinRK
|
r3768 | $ git pull | ||
Brian Granger
|
r1690 | |||
Thomas Kluyver
|
r21579 | .. _dependencies: | ||
Nikolay Koldunov
|
r16319 | |||
Thomas Kluyver
|
r21579 | Dependencies | ||
Matthias Bussonnier
|
r22588 | ~~~~~~~~~~~~ | ||
MinRK
|
r12090 | |||
Thomas Kluyver
|
r21579 | IPython relies on a number of other Python packages. Installing using a package | ||
manager like pip or conda will ensure the necessary packages are installed. If | ||||
you install manually, it's up to you to make sure dependencies are installed. | ||||
Carol Willing
|
r22594 | They're not listed here since a static list would inevitably fall out of date as | ||
dependencies may change from release to release and also vary depending on | ||||
the platform. | ||||