##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Sum documentation improvement from Mike getting-started session.
Matthias Bussonnier -
Show More
Show file before | Show file after | Hide comments
@@ -1,18 +1,28 b''
1 .. _core_developer_guide:
1 .. _core_developer_guide:
2
2
3 ==================================
3 ==================================
4 Developer's guide to core IPython
4 Guide for IPtyhon core Developpers
5 ==================================
5 ==================================
6
6
7 This guide documents the development of core IPython. Alternatively,
7 This guide documents the development of core IPython. Alternatively,
8 developers of third party tools and libraries that use IPython should see the
8 developers of third party tools and libraries that use IPython should see the
9 :doc:`../development/index`.
9 :doc:`../development/index`.
10
10
11 Developers working on core IPython should also consult the
11
12 `developer information <https://github.com/ipython/ipython/wiki/Dev:-Index>`_
12 For instruction on how to make a developer install see devinstall_.
13 on the IPython GitHub wiki.
14
13
15 .. toctree::
14 .. toctree::
16 :maxdepth: 1
15 :maxdepth: 1
17
16
18 release_process
17 release_process
18
19
20 Old Documentation
21 =================
22
23 Out of date documentation is still available and have been kept for archival
24 reason.
25
26 Developers working on core IPython should also consult the
27 `developer information <https://github.com/ipython/ipython/wiki/Dev:-Index>`_
28 on the IPython GitHub wiki.
Show file before | Show file after | Hide comments
@@ -1,132 +1,137 b''
1 Installing IPython
1 Installing IPython
2 ==================
2 ==================
3
3
4
4
5 IPython requires Python 2.7 or ≥ 3.3.
5 IPython requires Python 2.7 or ≥ 3.3.
6
6
7
7
8 Quick Install
8 Quick Install
9 -------------
9 -------------
10
10
11 With ``pip`` already installed :
11 With ``pip`` already installed :
12
12
13 .. code-block:: bash
13 .. code-block:: bash
14
14
15 $ pip install ipython
15 $ pip install ipython
16
16
17 This installs IPython as well as its dependencies.
17 This installs IPython as well as its dependencies.
18
18
19 If you want to use IPython with notebooks or the Qt console, you should also
19 If you want to use IPython with notebooks or the Qt console, you should also
20 install Jupyter ``pip install jupyter``.
20 install Jupyter ``pip install jupyter``.
21
21
22
22
23
23
24 Overview
24 Overview
25 --------
25 --------
26
26
27 This document describes in detail the steps required to install IPython.
27 This document describes in detail the steps required to install IPython. For a
28 For a few quick ways to get started with package managers or full Python distributions,
28 few quick ways to get started with package managers or full Python
29 see `the install page <http://ipython.org/install.html>`_ of the IPython website.
29 distributions, see `the install page <http://ipython.org/install.html>`_ of the
30 IPython website.
30
31
31 Please let us know if you have problems installing IPython or any of its dependencies.
32 Please let us know if you have problems installing IPython or any of its
33 dependencies.
32
34
33 IPython and most dependencies should be installed via :command:`pip`.
35 IPython and most dependencies should be installed via :command:`pip`.
34 In many scenarios, this is the simplest method of installing Python packages.
36 In many scenarios, this is the simplest method of installing Python packages.
35 More information about :mod:`pip` can be found on
37 More information about :mod:`pip` can be found on
36 `its PyPI page <https://pip.pypa.io>`__.
38 `its PyPI page <https://pip.pypa.io>`__.
37
39
38
40
39 More general information about installing Python packages can be found in
41 More general information about installing Python packages can be found in
40 `Python's documentation <http://docs.python.org>`_.
42 `Python's documentation <http://docs.python.org>`_.
41
43
44 .. _dependencies:
45
46 Dependencies
47 ~~~~~~~~~~~~
48
49 IPython relies on a number of other Python packages. Installing using a package
50 manager like pip or conda will ensure the necessary packages are installed. If
51 you install manually, it's up to you to make sure dependencies are installed.
52 They're not listed here since a static list would inevitably fall out of date as
53 dependencies may change from release to release and also vary depending on
54 the platform.
55
42
56
43 Installing IPython itself
57 Installing IPython itself
44 ~~~~~~~~~~~~~~~~~~~~~~~~~
58 ~~~~~~~~~~~~~~~~~~~~~~~~~
45
59
46 IPython requires several dependencies to work correctly, it is not recommended
60 IPython requires several dependencies to work correctly, it is not recommended
47 to install IPython and all its dependencies manually as this can be quite long and troublesome.
61 to install IPython and all its dependencies manually as this can be quite long
48 You should use the python package manager ``pip``.
62 and troublesome. You should use the python package manager ``pip``.
49
63
50 Installation using pip
64 Installation using pip
51 ~~~~~~~~~~~~~~~~~~~~~~
65 ~~~~~~~~~~~~~~~~~~~~~~
52
66
53 Make sure you have the latest version of :mod:`pip` (the Python package
67 Make sure you have the latest version of :mod:`pip` (the Python package
54 manager) installed. If you do not, head to `Pip documentation
68 manager) installed. If you do not, head to `Pip documentation
55 <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first.
69 <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first.
56
70
57 The quickest way to get up and running with IPython is to install it with pip:
71 The quickest way to get up and running with IPython is to install it with pip:
58
72
59 .. code-block:: bash
73 .. code-block:: bash
60
74
61 $ pip install ipython
75 $ pip install ipython
62
76
63 That's it.
77 That's it.
64
78
65
79
66 Installation from source
80 Installation from source
67 ~~~~~~~~~~~~~~~~~~~~~~~~
81 ~~~~~~~~~~~~~~~~~~~~~~~~
68
82
69 If you don't want to use :command:`pip`, or don't have it installed,
83 If you don't want to use :command:`pip`, or don't have it installed,
70 grab the latest stable tarball of IPython `from PyPI
84 grab the latest stable tarball of IPython `from PyPI
71 <https://pypi.python.org/pypi/ipython>`__. Then do the following:
85 <https://pypi.python.org/pypi/ipython>`__. Then do the following:
72
86
73 .. code-block:: bash
87 .. code-block:: bash
74
88
75 $ tar -xzf ipython.tar.gz
89 $ tar -xzf ipython.tar.gz
76 $ cd ipython
90 $ cd ipython
77 $ pip install .
91 $ pip install .
78
92
79 Do not invoke ``setup.py`` directly as this can have undesirable consequences for further upgrades.
93 Do not invoke ``setup.py`` directly as this can have undesirable consequences
80 Try to also avoid any usage of ``easy_install`` that can have similar undesirable consequences.
94 for further upgrades. Try to also avoid any usage of ``easy_install`` that can
95 have similar undesirable consequences.
81
96
82 If you are installing to a location (like ``/usr/local``) that requires higher
97 If you are installing to a location (like ``/usr/local``) that requires higher
83 permissions, you may need to run the last command with :command:`sudo`. You can
98 permissions, you may need to run the last command with :command:`sudo`. You can
84 also install in user specific location by using the ``--user`` flag in conjunction with pip.
99 also install in user specific location by using the ``--user`` flag in
100 conjunction with pip.
85
101
86 To run IPython's test suite, use the :command:`iptest` command from outside of the IPython source tree:
102 To run IPython's test suite, use the :command:`iptest` command from outside of
103 the IPython source tree:
87
104
88 .. code-block:: bash
105 .. code-block:: bash
89
106
90 $ iptest
107 $ iptest
91
108
92
109 .. _devinstall:
93 Installing the development version
110 Installing the development version
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
112
96 It is also possible to install the development version of IPython from our
113 It is also possible to install the development version of IPython from our
97 `Git <http://git-scm.com/>`_ source code repository. To do this you will
114 `Git <http://git-scm.com/>`_ source code repository. To do this you will
98 need to have Git installed on your system. Then do:
115 need to have Git installed on your system.
99
100 .. code-block:: bash
101
116
102 $ git clone https://github.com/ipython/ipython.git
103 $ cd ipython
104 $ pip install .
105
117
106 Some users want to be able to follow the development branch as it changes.
118 Then do:
107 With :mod:`pip` installed, you can replace the last step by:
108
119
109 .. code-block:: bash
120 .. code-block:: bash
110
121
122 $ git clone https://github.com/ipython/ipython.git
123 $ cd ipython
111 $ pip install -e .
124 $ pip install -e .
112
125
126 The `pip install -e .` allow users and developers to be able to follow the
127 development branch as it changes.
128
113 This creates links in the right places and installs the command line script to
129 This creates links in the right places and installs the command line script to
114 the appropriate location.
130 the appropriate location.
115
131
116 Then, if you want to update your IPython at any time, do:
132 Then, if you want to update your IPython at any time, do:
117
133
118 .. code-block:: bash
134 .. code-block:: bash
119
135
120 $ git pull
136 $ git pull
121
137
122 .. _dependencies:
123
124 Dependencies
125 ~~~~~~~~~~~~
126
127 IPython relies on a number of other Python packages. Installing using a package
128 manager like pip or conda will ensure the necessary packages are installed. If
129 you install manually, it's up to you to make sure dependencies are installed.
130 They're not listed here since a static list would inevitably fall out of date as
131 dependencies may change from release to release and also vary depending on
132 the platform.
General Comments 0
You need to be logged in to leave comments. Login now