##// END OF EJS Templates
Updated document...
Ankitsingh6299 -
Show More
@@ -1,148 +1,149 b''
1 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master
1 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master
2 :target: https://codecov.io/github/ipython/ipython?branch=master
2 :target: https://codecov.io/github/ipython/ipython?branch=master
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://img.shields.io/travis/ipython/ipython.svg
7 .. image:: https://img.shields.io/travis/ipython/ipython.svg
8 :target: https://travis-ci.org/ipython/ipython
8 :target: https://travis-ci.org/ipython/ipython
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
16
17 ===========================================
17 ===========================================
18 IPython: Productive Interactive Computing
18 IPython: Productive Interactive Computing
19 ===========================================
19 ===========================================
20
20
21 Overview
21 Overview
22 ========
22 ========
23
23
24 Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io
24 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
25 <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use, and
26 contribute to the project.
26 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.
27
28
28 **IPython versions and Python Support**
29 **IPython versions and Python Support**
29
30
30 Starting with IPython 7.10, IPython follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_
31 Starting with IPython 7.10, IPython follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_
31
32
32 **IPython 7.17+** requires Python version 3.7 and above.
33 **IPython 7.17+** requires Python version 3.7 and above.
33
34
34 **IPython 7.10+** requires Python version 3.6 and above.
35 **IPython 7.10+** requires Python version 3.6 and above.
35
36
36 **IPython 7.0** requires Python version 3.5 and above.
37 **IPython 7.0** requires Python version 3.5 and above.
37
38
38 **IPython 6.x** requires Python version 3.3 and above.
39 **IPython 6.x** requires Python version 3.3 and above.
39
40
40 **IPython 5.x LTS** is the compatible release for Python 2.7.
41 **IPython 5.x LTS** is the compatible release for Python 2.7.
41 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
42 If you require Python 2 support, you **must** use IPython 5.x LTS. Please
42 update your project configurations and requirements as necessary.
43 update your project configurations and requirements as necessary.
43
44
44
45
45 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
46 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
46 See the `Jupyter installation docs <https://jupyter.readthedocs.io/en/latest/install.html>`__
47 See the `Jupyter installation docs <https://jupyter.readthedocs.io/en/latest/install.html>`__
47 if you want to use these.
48 if you want to use these.
48
49
49
50
50
51
51
52
52 Development and Instant running
53 Development and Instant running
53 ===============================
54 ===============================
54
55
55 You can find the latest version of the development documentation on `readthedocs
56 You can find the latest version of the development documentation on `readthedocs
56 <https://ipython.readthedocs.io/en/latest/>`_.
57 <https://ipython.readthedocs.io/en/latest/>`_.
57
58
58 You can run IPython from this directory without even installing it system-wide
59 You can run IPython from this directory without even installing it system-wide
59 by typing at the terminal::
60 by typing at the terminal::
60
61
61 $ python -m IPython
62 $ python -m IPython
62
63
63 Or see the `development installation docs
64 Or see the `development installation docs
64 <https://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
65 <https://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
65 for the latest revision on read the docs.
66 for the latest revision on read the docs.
66
67
67 Documentation and installation instructions for older version of IPython can be
68 Documentation and installation instructions for older version of IPython can be
68 found on the `IPython website <https://ipython.org/documentation.html>`_
69 found on the `IPython website <https://ipython.org/documentation.html>`_
69
70
70
71
71
72
72 IPython requires Python version 3 or above
73 IPython requires Python version 3 or above
73 ==========================================
74 ==========================================
74
75
75 Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or
76 Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or
76 3.2.
77 3.2.
77
78
78 For a version compatible with Python 2.7, please install the 5.x LTS Long Term
79 For a version compatible with Python 2.7, please install the 5.x LTS Long Term
79 Support version.
80 Support version.
80
81
81 If you are encountering this error message you are likely trying to install or
82 If you are encountering this error message you are likely trying to install or
82 use IPython from source. You need to checkout the remote 5.x branch. If you are
83 use IPython from source. You need to checkout the remote 5.x branch. If you are
83 using git the following should work::
84 using git the following should work::
84
85
85 $ git fetch origin
86 $ git fetch origin
86 $ git checkout 5.x
87 $ git checkout 5.x
87
88
88 If you encounter this error message with a regular install of IPython, then you
89 If you encounter this error message with a regular install of IPython, then you
89 likely need to update your package manager, for example if you are using `pip`
90 likely need to update your package manager, for example if you are using `pip`
90 check the version of pip with::
91 check the version of pip with::
91
92
92 $ pip --version
93 $ pip --version
93
94
94 You will need to update pip to the version 9.0.1 or greater. If you are not using
95 You will need to update pip to the version 9.0.1 or greater. If you are not using
95 pip, please inquiry with the maintainers of the package for your package
96 pip, please inquiry with the maintainers of the package for your package
96 manager.
97 manager.
97
98
98 For more information see one of our blog posts:
99 For more information see one of our blog posts:
99
100
100 https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e
101 https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e
101
102
102 As well as the following Pull-Request for discussion:
103 As well as the following Pull-Request for discussion:
103
104
104 https://github.com/ipython/ipython/pull/9900
105 https://github.com/ipython/ipython/pull/9900
105
106
106 This error does also occur if you are invoking ``setup.py`` directly – which you
107 This error does also occur if you are invoking ``setup.py`` directly – which you
107 should not – or are using ``easy_install`` If this is the case, use ``pip
108 should not – or are using ``easy_install`` If this is the case, use ``pip
108 install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead
109 install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead
109 of ``setup.py develop`` If you are depending on IPython as a dependency you may
110 of ``setup.py develop`` If you are depending on IPython as a dependency you may
110 also want to have a conditional dependency on IPython depending on the Python
111 also want to have a conditional dependency on IPython depending on the Python
111 version::
112 version::
112
113
113 install_req = ['ipython']
114 install_req = ['ipython']
114 if sys.version_info[0] < 3 and 'bdist_wheel' not in sys.argv:
115 if sys.version_info[0] < 3 and 'bdist_wheel' not in sys.argv:
115 install_req.remove('ipython')
116 install_req.remove('ipython')
116 install_req.append('ipython<6')
117 install_req.append('ipython<6')
117
118
118 setup(
119 setup(
119 ...
120 ...
120 install_requires=install_req
121 install_requires=install_req
121 )
122 )
122
123
123 Alternatives to IPython
124 Alternatives to IPython
124 =======================
125 =======================
125
126
126 IPython may not be to your taste; if that's the case there might be similar
127 IPython may not be to your taste; if that's the case there might be similar
127 project that you might want to use:
128 project that you might want to use:
128
129
129 - the classic Python REPL.
130 - the classic Python REPL.
130 - `bpython <https://bpython-interpreter.org/>`_
131 - `bpython <https://bpython-interpreter.org/>`_
131 - `mypython <https://www.asmeurer.com/mypython/>`_
132 - `mypython <https://www.asmeurer.com/mypython/>`_
132 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`
133 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`
133 - `xonsh <https://xon.sh/>`
134 - `xonsh <https://xon.sh/>`
134
135
135 Ignoring commits with git blame.ignoreRevsFile
136 Ignoring commits with git blame.ignoreRevsFile
136 ==============================================
137 ==============================================
137
138
138 As of git 2.23, it is possible to make formatting changes without breaking
139 As of git 2.23, it is possible to make formatting changes without breaking
139 ``git blame``. See the `git documentation
140 ``git blame``. See the `git documentation
140 <https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_
141 <https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_
141 for more details.
142 for more details.
142
143
143 To use this feature you must:
144 To use this feature you must:
144
145
145 - Install git >= 2.23
146 - Install git >= 2.23
146 - Configure your local git repo by running:
147 - Configure your local git repo by running:
147 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
148 - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
148 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
149 - Windows: ``tools\configure-git-blame-ignore-revs.bat``
General Comments 0
You need to be logged in to leave comments. Login now