Official repository for IPython itself. Other repos in the IPython organization contain things like the website, documentation builds, etc.
.. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master :target: https://codecov.io/github/ipython/ipython?branch=master
.. image:: https://img.shields.io/pypi/v/IPython.svg :target: https://pypi.python.org/pypi/ipython
.. image:: https://img.shields.io/travis/ipython/ipython.svg :target: https://travis-ci.org/ipython/ipython
.. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg :target: https://www.codetriage.com/ipython/ipython/
.. image:: https://raster.shields.io/badge/Follows-NEP29-brightgreen.png :target: https://numpy.org/neps/nep-0029-deprecation_policy.html
Welcome to IPython. Our full documentation is available on
ipython.readthedocs.io_ and contains information on how to install, use, and contribute to the project. IPython (Interactive Python) is a command shell for interactive computing in multiple programming languages, originally developed for the Python programming language, that offers introspection, rich media, shell syntax, tab completion, and history.
IPython versions and Python Support
Starting with IPython 7.10, IPython follows
IPython 7.17+ requires Python version 3.7 and above.
IPython 7.10+ requires Python version 3.6 and above.
IPython 7.0 requires Python version 3.5 and above.
IPython 6.x requires Python version 3.3 and above.
IPython 5.x LTS is the compatible release for Python 2.7. If you require Python 2 support, you must use IPython 5.x LTS. Please update your project configurations and requirements as necessary.
The Notebook, Qt console and a number of other pieces are now parts of Jupyter. See the
Jupyter installation docs__ if you want to use these.
Comprehensive object introspection.
Input history, persistent across sessions.
Caching of output results during a session with automatically generated references.
Extensible tab completion, with support by default for completion of python variables and keywords, filenames and function keywords.
Extensible system of ‘magic’ commands for controlling the environment and performing many tasks related to IPython or the operating system.
A rich configuration system with easy switching between different setups (simpler than changing $PYTHONSTARTUP environment variables every time).
Session logging and reloading.
Extensible syntax processing for special purpose situations.
Access to the system shell with user-extensible alias system.
Easily embeddable in other Python programs and GUIs.
Integrated access to the pdb debugger and the Python profiler.
You can find the latest version of the development documentation on
You can run IPython from this directory without even installing it system-wide by typing at the terminal::
$ python -m IPython
Or see the
development installation docs_ for the latest revision on read the docs.
Documentation and installation instructions for older version of IPython can be found on the
Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or 3.2.
For a version compatible with Python 2.7, please install the 5.x LTS Long Term Support version.
If you are encountering this error message you are likely trying to install or use IPython from source. You need to checkout the remote 5.x branch. If you are using git the following should work::
$ git fetch origin $ git checkout 5.x
If you encounter this error message with a regular install of IPython, then you likely need to update your package manager, for example if you are using
pipcheck the version of pip with::
$ pip --version
You will need to update pip to the version 9.0.1 or greater. If you are not using pip, please inquiry with the maintainers of the package for your package manager.
For more information see one of our blog posts:
As well as the following Pull-Request for discussion:
This error does also occur if you are invoking
setup.pydirectly – which you should not – or are using
easy_installIf this is the case, use
pip install .instead of
setup.py install, and
pip install -e .instead of
setup.py developIf you are depending on IPython as a dependency you may also want to have a conditional dependency on IPython depending on the Python version::
install_req = ['ipython'] if sys.version_info < 3 and 'bdist_wheel' not in sys.argv: install_req.remove('ipython') install_req.append('ipython<6')
setup( ... install_requires=install_req )
IPython may not be to your taste; if that's the case there might be similar project that you might want to use:
ptpython and ptipython
As of git 2.23, it is possible to make formatting changes without breaking
git blame. See the
git documentation_ for more details.
To use this feature you must: