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