##// END OF EJS Templates
fix minor typo in README.rst
Thomas Hisch -
Show More
@@ -1,110 +1,110 b''
1 1 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master
2 2 :target: https://codecov.io/github/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 `ipython.readthedocs.io
22 22 <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use and
23 23 contribute to the project.
24 24
25 25 **IPython versions and Python Support**
26 26
27 27 **IPython 6** requires Python version 3.3 and above.
28 28
29 29 **IPython 5.x LTS** is the compatible release for Python 2.7.
30 30 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
31 31 update your project configurations and requirements as necessary.
32 32
33 33
34 34 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
35 35 See the `Jupyter installation docs <http://jupyter.readthedocs.io/en/latest/install.html>`__
36 36 if you want to use these.
37 37
38 38
39 39
40 40
41 41 Development and Instant running
42 42 ===============================
43 43
44 44 You can find the latest version of the development documentation on `readthedocs
45 45 <http://ipython.readthedocs.io/en/latest/>`_.
46 46
47 47 You can run IPython from this directory without even installing it system-wide
48 48 by typing at the terminal::
49 49
50 50 $ python -m IPython
51 51
52 52 Or see the `development installation docs
53 53 <http://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
54 54 for the latest revision on read the docs.
55 55
56 56 Documentation and installation instructions for older version of IPython can be
57 57 found on the `IPython website <http://ipython.org/documentation.html>`_
58 58
59 59
60 60
61 61 IPython requires Python version 3 or above
62 62 ==========================================
63 63
64 64 Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or
65 65 3.2.
66 66
67 67 For a version compatible with Python 2.7, please install the 5.x LTS Long Term
68 68 Support version.
69 69
70 70 If you are encountering this error message you are likely trying to install or
71 71 use IPython from source. You need to checkout the remote 5.x branch. If you are
72 72 using git the following should work:
73 73
74 74 $ git fetch origin
75 75 $ git checkout -b origin/5.x
76 76
77 77 If you encounter this error message with a regular install of IPython, then you
78 78 likely need to update your package manager, for example if you are using `pip`
79 79 check the version of pip with
80 80
81 81 $ pip --version
82 82
83 83 You will need to update pip to the version 9.0.1 or greater. If you are not using
84 84 pip, please inquiry with the maintainers of the package for your package
85 85 manager.
86 86
87 87 For more information see one of our blog posts:
88 88
89 89 http://blog.jupyter.org/2016/07/08/ipython-5-0-released/
90 90
91 91 As well as the following Pull-Request for discussion:
92 92
93 93 https://github.com/ipython/ipython/pull/9900
94 94
95 95 This error does also occur if you are invoking ``setup.py`` directly – which you
96 96 should not – or are using ``easy_install`` If this is the case, use ``pip
97 isntall .`` (instead of ``setup.py install`` , and ``pip install -e .`` instead
97 install .`` (instead of ``setup.py install`` , and ``pip install -e .`` instead
98 98 of ``setup.py develop`` If you are depending on IPython as a dependency you may
99 99 also want to have a conditional dependency on IPython depending on the Python
100 100 version::
101 101
102 102 install_req = ['ipython']
103 103 if sys.version_info[0] < 3 and 'bdist_wheel' not in sys.argv:
104 104 install_req.remove('ipython')
105 105 install_req.append('ipython<6')
106 106
107 107 setup(
108 108 ...
109 109 install_requires=install_req
110 110 )
General Comments 0
You need to be logged in to leave comments. Login now