Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Official repository for IPython itself. Other repos in the IPython organization contain things like the website, documentation builds, etc.

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 IPython
Octocat-spinner-32 docs
Octocat-spinner-32 examples
Octocat-spinner-32 git-hooks
Octocat-spinner-32 scripts
Octocat-spinner-32 setupext
Octocat-spinner-32 tools
Octocat-spinner-32 .gitattributes
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .gitmodules
Octocat-spinner-32 .mailmap
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 CONTRIBUTING.md
Octocat-spinner-32 COPYING.rst
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.rst
Octocat-spinner-32 setup.py
Octocat-spinner-32 setupbase.py
Octocat-spinner-32 setupegg.py
Octocat-spinner-32 tox.ini
README.rst

IPython: Productive Interactive Computing

Overview

Welcome to IPython. Our full documentation is available on our website; if you downloaded a built source distribution the docs/source directory contains the plaintext version of these manuals. If you have Sphinx installed, you can build them by typing cd docs; make html for local browsing.

Dependencies and supported Python versions

For full details, see the installation section of the manual. The basic parts of IPython only need the Python standard library, but much of its more advanced functionality requires extra packages.

Officially, IPython requires Python version 2.7, or 3.3 and above. IPython 1.x is the last IPython version to support Python 2.6 and 3.2.

Instant running

You can run IPython from this directory without even installing it system-wide by typing at the terminal:

$ python -m IPython

Development installation

If you want to hack on certain parts, e.g. the IPython notebook, in a clean environment (such as a virtualenv) you can use pip to grab the necessary dependencies quickly:

$ git clone --recursive https://github.com/ipython/ipython.git
$ cd ipython
$ pip install -e ".[notebook]"

This installs the necessary packages and symlinks IPython into your current environment so that you can work on your local repo copy and run it from anywhere:

$ ipython notebook

The same process applies for other parts, such as the qtconsole (the extras_require attribute in the setup.py file lists all the possibilities).

Git Hooks and Submodules

IPython now uses git submodules to ship its javascript dependencies. If you run IPython from git master, you may need to update submodules once in a while with:

$ git submodule update

or:

$ python setup.py submodule

We have some git hooks for helping keep your submodules always in sync, see our git-hooks directory for more info.

Something went wrong with that request. Please try again.