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