##// END OF EJS Templates
update install doc to reflect 0.11 changes and GitHub move...
MinRK -
Show More
@@ -66,8 +66,9 b' with no external dependencies. However, some Python distributions'
66 (particularly on Windows and OS X), don't come with a working :mod:`readline`
66 (particularly on Windows and OS X), don't come with a working :mod:`readline`
67 module. The IPython shell will work without :mod:`readline`, but will lack
67 module. The IPython shell will work without :mod:`readline`, but will lack
68 many features that users depend on, such as tab completion and command line
68 many features that users depend on, such as tab completion and command line
69 editing. See below for details of how to make sure you have a working
69 editing. If you install IPython with :mod:`setuptools`, (e.g. with `easy_install`),
70 :mod:`readline`.
70 then the appropriate :mod:`readline` for your platform will be installed.
71 See below for details of how to make sure you have a working :mod:`readline`.
71
72
72 Installation using easy_install
73 Installation using easy_install
73 -------------------------------
74 -------------------------------
@@ -86,7 +87,7 b' Installation from source'
86
87
87 If you don't want to use :command:`easy_install`, or don't have it installed,
88 If you don't want to use :command:`easy_install`, or don't have it installed,
88 just grab the latest stable build of IPython from `here
89 just grab the latest stable build of IPython from `here
89 <http://ipython.scipy.org/dist/>`_. Then do the following:
90 <https://github.com/ipython/ipython/downloads>`_. Then do the following:
90
91
91 .. code-block:: bash
92 .. code-block:: bash
92
93
@@ -107,7 +108,7 b' use any of the following alternatives:'
107
108
108 1. Install using :command:`easy_install`.
109 1. Install using :command:`easy_install`.
109
110
110 2. Install using our binary ``.exe`` Windows installer, which can be found at
111 2. Install using our binary ``.exe`` Windows installer, which can be found
111 `here <http://ipython.scipy.org/dist/>`_
112 `here <http://ipython.scipy.org/dist/>`_
112
113
113 3. Install from source, but using :mod:`setuptools` (``python setupegg.py
114 3. Install from source, but using :mod:`setuptools` (``python setupegg.py
@@ -135,12 +136,12 b' Installing the development version'
135 ----------------------------------
136 ----------------------------------
136
137
137 It is also possible to install the development version of IPython from our
138 It is also possible to install the development version of IPython from our
138 `Bazaar <http://bazaar-vcs.org/>`_ source code repository. To do this you will
139 `Git <http://git-scm.com/>`_ source code repository. To do this you will
139 need to have Bazaar installed on your system. Then just do:
140 need to have Git installed on your system. Then just do:
140
141
141 .. code-block:: bash
142 .. code-block:: bash
142
143
143 $ bzr branch lp:ipython
144 $ git clone https://github.com/ipython/ipython.git
144 $ cd ipython
145 $ cd ipython
145 $ python setup.py install
146 $ python setup.py install
146
147
@@ -161,7 +162,7 b' just do:'
161
162
162 .. code-block:: bash
163 .. code-block:: bash
163
164
164 $ bzr pull
165 $ git pull
165
166
166 Basic optional dependencies
167 Basic optional dependencies
167 ===========================
168 ===========================
@@ -187,6 +188,10 b" common situations where you won't have a working :mod:`readline` module:"
187
188
188 * If you are running Windows, which doesn't have a :mod:`readline` module.
189 * If you are running Windows, which doesn't have a :mod:`readline` module.
189
190
191 When IPython is installed with :mod:`setuptools`, (e.g. with `easy_install`),
192 readline is added as a dependency on OS X, and PyReadline on Windows, and will
193 be installed on your system. However, if you do not use setuptools, you may
194 have to install one of these packages yourself.
190
195
191 On OS X, the built-in Python doesn't not have :mod:`readline` because of
196 On OS X, the built-in Python doesn't not have :mod:`readline` because of
192 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
197 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
@@ -220,8 +225,7 b' wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).'
220 On Windows, you will need the PyReadline module. PyReadline is a separate,
225 On Windows, you will need the PyReadline module. PyReadline is a separate,
221 Windows only implementation of readline that uses native Windows calls through
226 Windows only implementation of readline that uses native Windows calls through
222 :mod:`ctypes`. The easiest way of installing PyReadline is you use the binary
227 :mod:`ctypes`. The easiest way of installing PyReadline is you use the binary
223 installer available `here <http://ipython.scipy.org/dist/>`_. The :mod:`ctypes`
228 installer available `here <https://launchpad.net/pyreadline/+download>`_.
224 module, which comes with Python 2.5 and greater, is required by PyReadline.
225
229
226 nose
230 nose
227 ----
231 ----
@@ -257,8 +261,10 b' iptest command:'
257 pexpect
261 pexpect
258 -------
262 -------
259
263
260 The `pexpect <http://www.noah.org/wiki/Pexpect>`_ package is used in IPython's
264 The pexpect package is used in IPython's :command:`irunner` script, as well as
261 :command:`irunner` script. On Unix platforms (including OS X), just do:
265 for managing subprocesses [pexpect]_. IPython now includes a version of pexpect
266 in :mod:`IPython.external`, but if you have installed pexpect, IPython will use
267 that instead. On Unix platforms (including OS X), just do:
262
268
263 .. code-block:: bash
269 .. code-block:: bash
264
270
@@ -318,11 +324,9 b' pygments'
318 --------
324 --------
319
325
320 The syntax-highlighting in ``ipython-qtconsole`` is done with the pygments project,
326 The syntax-highlighting in ``ipython-qtconsole`` is done with the pygments project,
321 which is easy_install-able.
327 which is easy_install-able [pygments]_.
322
328
323 .. [Twisted] Twisted matrix. http://twistedmatrix.org
324 .. [ZopeInterface] http://pypi.python.org/pypi/zope.interface
325 .. [Foolscap] Foolscap network protocol. http://foolscap.lothar.com/trac
326 .. [pyOpenSSL] pyOpenSSL. http://pyopenssl.sourceforge.net
327 .. [ZeroMQ] ZeroMQ. http://www.zeromq.org
329 .. [ZeroMQ] ZeroMQ. http://www.zeromq.org
328 .. [paramiko] paramiko. https://github.com/robey/paramiko
330 .. [paramiko] paramiko. https://github.com/robey/paramiko
331 .. [pygments] Pygments syntax highlighting. http://pygments.org
332 .. [pexpect] Pexpect. http://www.noah.org/wiki/Pexpect
General Comments 0
You need to be logged in to leave comments. Login now