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