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