Installing IPython

IPython requires Python ≥ 3.11.

Quick Install

Withpip already installed :

$pipinstallipython

This installs IPython as well as its dependencies.

If you want to use IPython with notebooks or the Qt console, you should alsoinstall Jupyterpipinstalljupyter.

Overview

This document describes in detail the steps required to install IPython. For afew quick ways to get started with package managers or full Pythondistributions, seethe install page of theIPython website.

Please let us know if you have problems installing IPython or any of itsdependencies.

IPython and most dependencies should be installed viapip.In many scenarios, this is the simplest method of installing Python packages.More information aboutpip can be found onits PyPI page.

More general information about installing Python packages can be found inPython’s documentation.

Dependencies

IPython relies on a number of other Python packages. Installing using a packagemanager like pip or conda will ensure the necessary packages are installed.Manual installation without dependencies is possible, but not recommended.The dependencies can be viewed with package manager commands,such aspip show ipython orconda info ipython.

Installing IPython itself

IPython requires several dependencies to work correctly, it is not recommendedto install IPython and all its dependencies manually as this can be quite longand troublesome. You should use the python package managerpip.

Installation using pip

Make sure you have the latest version ofpip (the Python packagemanager) installed. If you do not, head toPip documentation and installpip first.

The quickest way to get up and running with IPython is to install it with pip:

$pipinstallipython

That’s it.

Optional: Command-line completion

IPython supports command-line completion via theargcomplete package.To enable tab completion for IPython and other Python programs that supportargcomplete, install IPython with theterminal extra:

$pipinstallipython[all]$activate-global-python-argcomplete

Alternatively, you can install argcomplete separately:

$pipinstallargcomplete$activate-global-python-argcomplete

This will enable shell completion for all Python programs that support argcomplete,including IPython. Note that you may need to restart your shell for the changesto take effect.

For more information, see theargcomplete documentation.

Installing the development version

It is also possible to install the development version of IPython from ourGit source code repository. To do this you willneed to have Git installed on your system.

Then do:

$gitclonehttps://github.com/ipython/ipython.git$cdipython$pipinstall-e'.[test]'

Thepip install -e . command allows users and developers to followthe development branch as it changes by creating links in the right places andinstalling the command line scripts to the appropriate locations.

Then, if you want to update your IPython at any time, do:

$gitpull

If the dependencies or entrypoints have changed, you may have to run

$pipinstall-e.

again, but this is infrequent.