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