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