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