##// END OF EJS Templates
Add an important directive for Py2/Py3 support
Carol Willing -
Show More
@@ -1,87 +1,94 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 Officially, IPython requires Python version 3.3 and above.
26 IPython 5.x is the last IPython version to support Python 2.7.
25 .. important::
26 **IPython versions and Python Support**
27
28 **IPython 6** requires Python version 3.3 and above.
29
30 **IPython 5.x LTS** is the compatible release for Python 2.x, 3.0, 3.1, 3.2.
31 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
32 update your project configurations and requirements as necessary.
33
27 34
28 35 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
29 36 See the `Jupyter installation docs <http://jupyter.readthedocs.io/en/latest/install.html>`__
30 37 if you want to use these.
31 38
32 39
33 40
34 41
35 42 Development and Instant running
36 43 ===============================
37 44
38 45 You can find the latest version of the development documentation on `readthedocs
39 46 <http://ipython.readthedocs.io/en/latest/>`_.
40 47
41 48 You can run IPython from this directory without even installing it system-wide
42 49 by typing at the terminal::
43 50
44 51 $ python -m IPython
45 52
46 53 Or see the `development installation docs
47 54 <http://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
48 55 for the latest revision on read the docs.
49 56
50 57 Documentation and installation instructions for older version of IPython can be
51 58 found on the `IPython website <http://ipython.org/documentation.html>`_
52 59
53 60
54 61
55 62 IPython requires Python version 3 or above
56 63 ==========================================
57 64
58 65 Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or
59 66 3.2.
60 67
61 68 For a version compatible with Python 2.7, please install the 5.x LTS Long Term
62 69 Support version.
63 70
64 71 If you are encountering this error message you are likely trying to install or
65 72 use IPython from source. You need to checkout the remote 5.x branch. If you are
66 73 using git the following should work:
67 74
68 75 $ git fetch origin
69 76 $ git checkout -b origin/5.x
70 77
71 78 If you encounter this error message with a regular install of IPython, then you
72 79 likely need to update your package manager, for example if you are using `pip`
73 80 check the version of pip with
74 81
75 82 $ pip --version
76 83
77 84 You will need to update pip to the version 8.2 or greater. If you are not using
78 85 pip, please inquiry with the maintainers of the package for your package
79 86 manager.
80 87
81 88 For more information see one of our blog posts:
82 89
83 90 http://blog.jupyter.org/2016/07/08/ipython-5-0-released/
84 91
85 92 As well as the following Pull-Request for discussion:
86 93
87 94 https://github.com/ipython/ipython/pull/9900
General Comments 0
You need to be logged in to leave comments. Login now