Skip to content

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.
Python JavaScript HTML Other

Merge pull request #8215 from minrk/button-right-of-logo

add header_buttons block to page template
latest commit 7d7980b123
@Carreau Carreau authored
Failed to load latest commit information.
IPython Merge pull request #8215 from minrk/button-right-of-logo
docs more docs on building docs
examples Provide the notebook being imported with "get_ipython"
git-hooks Git hooks need to use invoke, not fab
ipython_kernel Merge pull request #8204 from minrk/split-kernel-client
ipython_parallel missing allow_none=True in IPython.parallel
jupyter_client Merge pull request #8204 from minrk/split-kernel-client
jupyter_console allow_none=False by default for Type and Instance
jupyter_nbconvert another stab at confining images to page width
jupyter_nbformat profile_dir
jupyter_qtconsole Forward port #8209
scripts Remove some leftover traces of irunner
setupext remove non-setuptools dependency checks
tools update confined output test notebook
traitlets update traitlets imports
.gitattributes Tell git about certain file extensions (.py, .js, .html) for use in w…
.gitignore [issue547] add emacs tmp files and .coverage files to gitignore
.gitmodules re-add components submodule
.mailmap update mailmap
.travis.yml Use -e flag to install on Travis
CONTRIBUTING.md Mention that we don't do cleanup PRs
COPYING.rst remove weird unicode space in the new copyright header
Dockerfile Bump less to @<3.0 so setup.py css works
MANIFEST.in Remove outdated path from MANIFEST.in
README.rst readme badges
setup.py disable install from master
setupbase.py kernel.resources isn't a package
setupegg.py Don't use execfile in setupegg.py
tox.ini use invoke instead of fabric

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]" --user

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.