##// END OF EJS Templates
readme badges
Matthias Bussonnier -
Show More
@@ -1,67 +1,80 b''
1 .. image:: https://img.shields.io/coveralls/ipython/ipython.svg
2 :target: https://coveralls.io/r/ipython/ipython?branch=master
3
4 .. image:: https://img.shields.io/pypi/dm/IPython.svg
5 :target: https://pypi.python.org/pypi/ipython
6
7 .. image:: https://img.shields.io/pypi/v/IPython.svg
8 :target: https://pypi.python.org/pypi/ipython
9
10 .. image:: https://img.shields.io/travis/ipython/ipython.svg
11 :target: https://travis-ci.org/ipython/ipython
12
13
1 14 ===========================================
2 15 IPython: Productive Interactive Computing
3 16 ===========================================
4 17
5 18 Overview
6 19 ========
7 20
8 21 Welcome to IPython. Our full documentation is available on `our website
9 22 <http://ipython.org/documentation.html>`_; if you downloaded a built source
10 23 distribution the ``docs/source`` directory contains the plaintext version of
11 24 these manuals. If you have Sphinx installed, you can build them by typing
12 25 ``cd docs; make html`` for local browsing.
13 26
14 27
15 28 Dependencies and supported Python versions
16 29 ==========================================
17 30
18 31 For full details, see the installation section of the manual. The basic parts
19 32 of IPython only need the Python standard library, but much of its more advanced
20 33 functionality requires extra packages.
21 34
22 35 Officially, IPython requires Python version 2.7, or 3.3 and above.
23 36 IPython 1.x is the last IPython version to support Python 2.6 and 3.2.
24 37
25 38
26 39 Instant running
27 40 ===============
28 41
29 42 You can run IPython from this directory without even installing it system-wide
30 43 by typing at the terminal::
31 44
32 45 $ python -m IPython
33 46
34 47
35 48 Development installation
36 49 ========================
37 50
38 51 If you want to hack on certain parts, e.g. the IPython notebook, in a clean
39 52 environment (such as a virtualenv) you can use ``pip`` to grab the necessary
40 53 dependencies quickly::
41 54
42 55 $ git clone --recursive https://github.com/ipython/ipython.git
43 56 $ cd ipython
44 57 $ pip install -e ".[notebook]" --user
45 58
46 59 This installs the necessary packages and symlinks IPython into your current
47 60 environment so that you can work on your local repo copy and run it from anywhere::
48 61
49 62 $ ipython notebook
50 63
51 64 The same process applies for other parts, such as the qtconsole (the
52 65 ``extras_require`` attribute in the setup.py file lists all the possibilities).
53 66
54 67 Git Hooks and Submodules
55 68 ************************
56 69
57 70 IPython now uses git submodules to ship its javascript dependencies.
58 71 If you run IPython from git master, you may need to update submodules once in a while with::
59 72
60 73 $ git submodule update
61 74
62 75 or::
63 76
64 77 $ python setup.py submodule
65 78
66 79 We have some git hooks for helping keep your submodules always in sync,
67 80 see our ``git-hooks`` directory for more info.
General Comments 0
You need to be logged in to leave comments. Login now