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