##// END OF EJS Templates
Remove old Python2/3 informations from the Readme.rst
M Bussonnier -
Show More
@@ -1,176 +1,124 b''
1 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=main
1 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=main
2 :target: https://codecov.io/github/ipython/ipython?branch=main
2 :target: https://codecov.io/github/ipython/ipython?branch=main
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://github.com/ipython/ipython/actions/workflows/test.yml/badge.svg
7 .. image:: https://github.com/ipython/ipython/actions/workflows/test.yml/badge.svg
8 :target: https://github.com/ipython/ipython/actions/workflows/test.yml
8 :target: https://github.com/ipython/ipython/actions/workflows/test.yml
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-SPEC--0000-brightgreen.png
13 .. image:: https://raster.shields.io/badge/Follows-SPEC--0000-brightgreen.png
14 :target: https://scientific-python.org/specs/spec-0000/
14 :target: https://scientific-python.org/specs/spec-0000/
15
15
16 .. image:: https://tidelift.com/badges/package/pypi/ipython?style=flat
16 .. image:: https://tidelift.com/badges/package/pypi/ipython?style=flat
17 :target: https://tidelift.com/subscription/pkg/pypi-ipython
17 :target: https://tidelift.com/subscription/pkg/pypi-ipython
18
18
19
19
20 ===========================================
20 ===========================================
21 IPython: Productive Interactive Computing
21 IPython: Productive Interactive Computing
22 ===========================================
22 ===========================================
23
23
24 Overview
24 Overview
25 ========
25 ========
26
26
27 Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io
27 Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io
28 <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use, and
28 <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use, and
29 contribute to the project.
29 contribute to the project.
30 IPython (Interactive Python) is a command shell for interactive computing in multiple programming languages, originally developed for the Python programming language, that offers introspection, rich media, shell syntax, tab completion, and history.
30 IPython (Interactive Python) is a command shell for interactive computing in multiple programming languages, originally developed for the Python programming language, that offers introspection, rich media, shell syntax, tab completion, and history.
31
31
32 **IPython versions and Python Support**
32 **IPython versions and Python Support**
33
33
34 Starting after IPython 8.16, we will progressively transition to `Spec-0000 <https://scientific-python.org/specs/spec-0000/>`_.
34 Starting after IPython 8.16, we will progressively transition to `Spec-0000 <https://scientific-python.org/specs/spec-0000/>`_.
35
35
36 Starting with IPython 7.10, IPython follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_
36 Starting with IPython 7.10, IPython follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_
37
37
38 **IPython 7.17+** requires Python version 3.7 and above.
38 **IPython 7.17+** requires Python version 3.7 and above.
39
39
40 **IPython 7.10+** requires Python version 3.6 and above.
40 **IPython 7.10+** requires Python version 3.6 and above.
41
41
42 **IPython 7.0** requires Python version 3.5 and above.
42 **IPython 7.0** requires Python version 3.5 and above.
43
43
44 **IPython 6.x** requires Python version 3.3 and above.
44 **IPython 6.x** requires Python version 3.3 and above.
45
45
46 **IPython 5.x LTS** is the compatible release for Python 2.7.
46 **IPython 5.x LTS** is the compatible release for Python 2.7.
47 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
47 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
48 update your project configurations and requirements as necessary.
48 update your project configurations and requirements as necessary.
49
49
50
50
51 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
51 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
52 See the `Jupyter installation docs <https://jupyter.readthedocs.io/en/latest/install.html>`__
52 See the `Jupyter installation docs <https://jupyter.readthedocs.io/en/latest/install.html>`__
53 if you want to use these.
53 if you want to use these.
54
54
55 Main features of IPython
55 Main features of IPython
56 ========================
56 ========================
57 Comprehensive object introspection.
57 Comprehensive object introspection.
58
58
59 Input history, persistent across sessions.
59 Input history, persistent across sessions.
60
60
61 Caching of output results during a session with automatically generated references.
61 Caching of output results during a session with automatically generated references.
62
62
63 Extensible tab completion, with support by default for completion of python variables and keywords, filenames and function keywords.
63 Extensible tab completion, with support by default for completion of python variables and keywords, filenames and function keywords.
64
64
65 Extensible system of β€˜magic’ commands for controlling the environment and performing many tasks related to IPython or the operating system.
65 Extensible system of β€˜magic’ commands for controlling the environment and performing many tasks related to IPython or the operating system.
66
66
67 A rich configuration system with easy switching between different setups (simpler than changing $PYTHONSTARTUP environment variables every time).
67 A rich configuration system with easy switching between different setups (simpler than changing $PYTHONSTARTUP environment variables every time).
68
68
69 Session logging and reloading.
69 Session logging and reloading.
70
70
71 Extensible syntax processing for special purpose situations.
71 Extensible syntax processing for special purpose situations.
72
72
73 Access to the system shell with user-extensible alias system.
73 Access to the system shell with user-extensible alias system.
74
74
75 Easily embeddable in other Python programs and GUIs.
75 Easily embeddable in other Python programs and GUIs.
76
76
77 Integrated access to the pdb debugger and the Python profiler.
77 Integrated access to the pdb debugger and the Python profiler.
78
78
79
79
80 Development and Instant running
80 Development and Instant running
81 ===============================
81 ===============================
82
82
83 You can find the latest version of the development documentation on `readthedocs
83 You can find the latest version of the development documentation on `readthedocs
84 <https://ipython.readthedocs.io/en/latest/>`_.
84 <https://ipython.readthedocs.io/en/latest/>`_.
85
85
86 You can run IPython from this directory without even installing it system-wide
86 You can run IPython from this directory without even installing it system-wide
87 by typing at the terminal::
87 by typing at the terminal::
88
88
89 $ python -m IPython
89 $ python -m IPython
90
90
91 Or see the `development installation docs
91 Or see the `development installation docs
92 <https://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
92 <https://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
93 for the latest revision on read the docs.
93 for the latest revision on read the docs.
94
94
95 Documentation and installation instructions for older version of IPython can be
95 Documentation and installation instructions for older version of IPython can be
96 found on the `IPython website <https://ipython.org/documentation.html>`_
96 found on the `IPython website <https://ipython.org/documentation.html>`_
97
97
98
98
99
100 IPython requires Python version 3 or above
101 ==========================================
102
103 Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or
104 3.2.
105
106 For a version compatible with Python 2.7, please install the 5.x LTS Long Term
107 Support version.
108
109 If you are encountering this error message you are likely trying to install or
110 use IPython from source. You need to checkout the remote 5.x branch. If you are
111 using git the following should work::
112
113 $ git fetch origin
114 $ git checkout 5.x
115
116 If you encounter this error message with a regular install of IPython, then you
117 likely need to update your package manager, for example if you are using `pip`
118 check the version of pip with::
119
120 $ pip --version
121
122 You will need to update pip to the version 9.0.1 or greater. If you are not using
123 pip, please inquiry with the maintainers of the package for your package
124 manager.
125
126 For more information see one of our blog posts:
127
128 https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e
129
130 As well as the following Pull-Request for discussion:
131
132 https://github.com/ipython/ipython/pull/9900
133
134 This error does also occur if you are invoking ``setup.py`` directly – which you
135 should not – or are using ``easy_install`` If this is the case, use ``pip
136 install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead
137 of ``setup.py develop`` If you are depending on IPython as a dependency you may
138 also want to have a conditional dependency on IPython depending on the Python
139 version::
140
141 install_req = ['ipython']
142 if sys.version_info[0] < 3 and 'bdist_wheel' not in sys.argv:
143 install_req.remove('ipython')
144 install_req.append('ipython<6')
145
146 setup(
147 ...
148 install_requires=install_req
149 )
150
151 Alternatives to IPython
99 Alternatives to IPython
152 =======================
100 =======================
153
101
154 IPython may not be to your taste; if that's the case there might be similar
102 IPython may not be to your taste; if that's the case there might be similar
155 project that you might want to use:
103 project that you might want to use:
156
104
157 - The classic Python REPL.
105 - The classic Python REPL.
158 - `bpython <https://bpython-interpreter.org/>`_
106 - `bpython <https://bpython-interpreter.org/>`_
159 - `mypython <https://www.asmeurer.com/mypython/>`_
107 - `mypython <https://www.asmeurer.com/mypython/>`_
160 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`_
108 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`_
161 - `Xonsh <https://xon.sh/>`_
109 - `Xonsh <https://xon.sh/>`_
162
110
163 Ignoring commits with git blame.ignoreRevsFile
111 Ignoring commits with git blame.ignoreRevsFile
164 ==============================================
112 ==============================================
165
113
166 As of git 2.23, it is possible to make formatting changes without breaking
114 As of git 2.23, it is possible to make formatting changes without breaking
167 ``git blame``. See the `git documentation
115 ``git blame``. See the `git documentation
168 <https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_
116 <https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_
169 for more details.
117 for more details.
170
118
171 To use this feature you must:
119 To use this feature you must:
172
120
173 - Install git >= 2.23
121 - Install git >= 2.23
174 - Configure your local git repo by running:
122 - Configure your local git repo by running:
175 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
123 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
176 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
124 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
General Comments 0
You need to be logged in to leave comments. Login now