##// END OF EJS Templates
Merge pull request #13748 from Carreau/tidelift...
Matthias Bussonnier -
r27790:06d78721 merge
parent child Browse files
Show More
@@ -1,171 +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/subscription/pkg/pypi-ipython
17 :target: https://tidelift.com/badges/package/pypi/ipython?style=flat
18
16
19
17 ===========================================
20 ===========================================
18 IPython: Productive Interactive Computing
21 IPython: Productive Interactive Computing
19 ===========================================
22 ===========================================
20
23
21 Overview
24 Overview
22 ========
25 ========
23
26
24 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
25 <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
26 contribute to the project.
29 contribute to the project.
27 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.
28
31
29 **IPython versions and Python Support**
32 **IPython versions and Python Support**
30
33
31 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>`_
32
35
33 **IPython 7.17+** requires Python version 3.7 and above.
36 **IPython 7.17+** requires Python version 3.7 and above.
34
37
35 **IPython 7.10+** requires Python version 3.6 and above.
38 **IPython 7.10+** requires Python version 3.6 and above.
36
39
37 **IPython 7.0** requires Python version 3.5 and above.
40 **IPython 7.0** requires Python version 3.5 and above.
38
41
39 **IPython 6.x** requires Python version 3.3 and above.
42 **IPython 6.x** requires Python version 3.3 and above.
40
43
41 **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.
42 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
43 update your project configurations and requirements as necessary.
46 update your project configurations and requirements as necessary.
44
47
45
48
46 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*.
47 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>`__
48 if you want to use these.
51 if you want to use these.
49
52
50 Main features of IPython
53 Main features of IPython
51 ========================
54 ========================
52 Comprehensive object introspection.
55 Comprehensive object introspection.
53
56
54 Input history, persistent across sessions.
57 Input history, persistent across sessions.
55
58
56 Caching of output results during a session with automatically generated references.
59 Caching of output results during a session with automatically generated references.
57
60
58 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.
59
62
60 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.
61
64
62 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).
63
66
64 Session logging and reloading.
67 Session logging and reloading.
65
68
66 Extensible syntax processing for special purpose situations.
69 Extensible syntax processing for special purpose situations.
67
70
68 Access to the system shell with user-extensible alias system.
71 Access to the system shell with user-extensible alias system.
69
72
70 Easily embeddable in other Python programs and GUIs.
73 Easily embeddable in other Python programs and GUIs.
71
74
72 Integrated access to the pdb debugger and the Python profiler.
75 Integrated access to the pdb debugger and the Python profiler.
73
76
74
77
75 Development and Instant running
78 Development and Instant running
76 ===============================
79 ===============================
77
80
78 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
79 <https://ipython.readthedocs.io/en/latest/>`_.
82 <https://ipython.readthedocs.io/en/latest/>`_.
80
83
81 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
82 by typing at the terminal::
85 by typing at the terminal::
83
86
84 $ python -m IPython
87 $ python -m IPython
85
88
86 Or see the `development installation docs
89 Or see the `development installation docs
87 <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>`_
88 for the latest revision on read the docs.
91 for the latest revision on read the docs.
89
92
90 Documentation and installation instructions for older version of IPython can be
93 Documentation and installation instructions for older version of IPython can be
91 found on the `IPython website <https://ipython.org/documentation.html>`_
94 found on the `IPython website <https://ipython.org/documentation.html>`_
92
95
93
96
94
97
95 IPython requires Python version 3 or above
98 IPython requires Python version 3 or above
96 ==========================================
99 ==========================================
97
100
98 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
99 3.2.
102 3.2.
100
103
101 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
102 Support version.
105 Support version.
103
106
104 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
105 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
106 using git the following should work::
109 using git the following should work::
107
110
108 $ git fetch origin
111 $ git fetch origin
109 $ git checkout 5.x
112 $ git checkout 5.x
110
113
111 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
112 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`
113 check the version of pip with::
116 check the version of pip with::
114
117
115 $ pip --version
118 $ pip --version
116
119
117 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
118 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
119 manager.
122 manager.
120
123
121 For more information see one of our blog posts:
124 For more information see one of our blog posts:
122
125
123 https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e
126 https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e
124
127
125 As well as the following Pull-Request for discussion:
128 As well as the following Pull-Request for discussion:
126
129
127 https://github.com/ipython/ipython/pull/9900
130 https://github.com/ipython/ipython/pull/9900
128
131
129 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
130 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
131 install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead
134 install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead
132 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
133 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
134 version::
137 version::
135
138
136 install_req = ['ipython']
139 install_req = ['ipython']
137 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:
138 install_req.remove('ipython')
141 install_req.remove('ipython')
139 install_req.append('ipython<6')
142 install_req.append('ipython<6')
140
143
141 setup(
144 setup(
142 ...
145 ...
143 install_requires=install_req
146 install_requires=install_req
144 )
147 )
145
148
146 Alternatives to IPython
149 Alternatives to IPython
147 =======================
150 =======================
148
151
149 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
150 project that you might want to use:
153 project that you might want to use:
151
154
152 - The classic Python REPL.
155 - The classic Python REPL.
153 - `bpython <https://bpython-interpreter.org/>`_
156 - `bpython <https://bpython-interpreter.org/>`_
154 - `mypython <https://www.asmeurer.com/mypython/>`_
157 - `mypython <https://www.asmeurer.com/mypython/>`_
155 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`_
158 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`_
156 - `Xonsh <https://xon.sh/>`_
159 - `Xonsh <https://xon.sh/>`_
157
160
158 Ignoring commits with git blame.ignoreRevsFile
161 Ignoring commits with git blame.ignoreRevsFile
159 ==============================================
162 ==============================================
160
163
161 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
162 ``git blame``. See the `git documentation
165 ``git blame``. See the `git documentation
163 <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>`_
164 for more details.
167 for more details.
165
168
166 To use this feature you must:
169 To use this feature you must:
167
170
168 - Install git >= 2.23
171 - Install git >= 2.23
169 - Configure your local git repo by running:
172 - Configure your local git repo by running:
170 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
173 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
171 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
174 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
@@ -1,6 +1,10 b''
1 # Security Policy
1 # Security Policy
2
2
3 ## Reporting a Vulnerability
3 ## Reporting a Vulnerability
4
4
5 All IPython and Jupyter security are handled via security@ipython.org.
5 All IPython and Jupyter security are handled via security@ipython.org.
6 You can find more information on the Jupyter website. https://jupyter.org/security
6 You can find more information on the Jupyter website. https://jupyter.org/security
7
8 ## Tidelift
9
10 You can report security concerns for IPython via the [Tidelift platform](https://tidelift.com/security).
General Comments 0
You need to be logged in to leave comments. Login now