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