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