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