README.rst
176 lines
| 6.4 KiB
| text/x-rst
|
RstLexer
Jarrod Millman
|
r27712 | .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=main | ||
:target: https://codecov.io/github/ipython/ipython?branch=main | ||||
Matthias Bussonnier
|
r19865 | |||
Carol Willing
|
r23534 | .. image:: https://img.shields.io/pypi/v/IPython.svg | ||
Matthias Bussonnier
|
r19865 | :target: https://pypi.python.org/pypi/ipython | ||
Carol Willing
|
r26456 | .. image:: https://github.com/ipython/ipython/actions/workflows/test.yml/badge.svg | ||
krassowski
|
r27924 | :target: https://github.com/ipython/ipython/actions/workflows/test.yml | ||
Matthias Bussonnier
|
r19865 | |||
Mradul Dubey
|
r23720 | .. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg | ||
:target: https://www.codetriage.com/ipython/ipython/ | ||||
Matthias Bussonnier
|
r19865 | |||
Matthias Bussonnier
|
r28428 | .. image:: https://raster.shields.io/badge/Follows-SPEC--0000-brightgreen.png | ||
:target: https://scientific-python.org/specs/spec-0000/ | ||||
Matthias Bussonnier
|
r25225 | |||
Hassan Tahir
|
r27825 | .. image:: https://tidelift.com/badges/package/pypi/ipython?style=flat | ||
:target: https://tidelift.com/subscription/pkg/pypi-ipython | ||||
Matthias Bussonnier
|
r27781 | |||
Matthias Bussonnier
|
r25225 | |||
Fernando Perez
|
r4459 | =========================================== | ||
IPython: Productive Interactive Computing | ||||
=========================================== | ||||
fperez
|
r0 | |||
Brian E Granger
|
r1250 | Overview | ||
======== | ||||
darren.dale
|
r864 | |||
Matthias Bussonnier
|
r22640 | Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io | ||
CarsonGSmith
|
r24794 | <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use, and | ||
Matthias Bussonnier
|
r22640 | contribute to the project. | ||
Ankitsingh6299
|
r26031 | 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. | ||
Brian Granger
|
r1719 | |||
Thomas Kluyver
|
r23535 | **IPython versions and Python Support** | ||
Carol Willing
|
r23534 | |||
Matthias Bussonnier
|
r28428 | Starting after IPython 8.16, we will progressively transition to `Spec-0000 <https://scientific-python.org/specs/spec-0000/>`_. | ||
Matthias Bussonnier
|
r25225 | Starting with IPython 7.10, IPython follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_ | ||
Matthias Bussonnier
|
r25974 | **IPython 7.17+** requires Python version 3.7 and above. | ||
Matthias Bussonnier
|
r25225 | **IPython 7.10+** requires Python version 3.6 and above. | ||
kd2718
|
r24793 | **IPython 7.0** requires Python version 3.5 and above. | ||
Hugo
|
r24260 | |||
Thomas Kluyver
|
r24261 | **IPython 6.x** requires Python version 3.3 and above. | ||
Carol Willing
|
r23534 | |||
Thomas Kluyver
|
r23535 | **IPython 5.x LTS** is the compatible release for Python 2.7. | ||
If you require Python 2 support, you **must** use IPython 5.x LTS. Please | ||||
update your project configurations and requirements as necessary. | ||||
Carol Willing
|
r23534 | |||
Fernando Perez
|
r2573 | |||
Thomas Kluyver
|
r21596 | The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*. | ||
stonebig
|
r24303 | See the `Jupyter installation docs <https://jupyter.readthedocs.io/en/latest/install.html>`__ | ||
Thomas Kluyver
|
r21596 | if you want to use these. | ||
Fernando Perez
|
r2573 | |||
Sanjana-03
|
r26117 | Main features of IPython | ||
======================== | ||||
Comprehensive object introspection. | ||||
Fernando Perez
|
r2573 | |||
Sanjana-03
|
r26117 | Input history, persistent across sessions. | ||
Caching of output results during a session with automatically generated references. | ||||
Extensible tab completion, with support by default for completion of python variables and keywords, filenames and function keywords. | ||||
Extensible system of ‘magic’ commands for controlling the environment and performing many tasks related to IPython or the operating system. | ||||
A rich configuration system with easy switching between different setups (simpler than changing $PYTHONSTARTUP environment variables every time). | ||||
Session logging and reloading. | ||||
Extensible syntax processing for special purpose situations. | ||||
Access to the system shell with user-extensible alias system. | ||||
Easily embeddable in other Python programs and GUIs. | ||||
Integrated access to the pdb debugger and the Python profiler. | ||||
Aaron Meurer
|
r7825 | |||
Matthias Bussonnier
|
r22640 | |||
Matthias Bussonnier
|
r22826 | Development and Instant running | ||
=============================== | ||||
Matthias Bussonnier
|
r22640 | |||
You can find the latest version of the development documentation on `readthedocs | ||||
stonebig
|
r24303 | <https://ipython.readthedocs.io/en/latest/>`_. | ||
Fernando Perez
|
r2481 | |||
You can run IPython from this directory without even installing it system-wide | ||||
MinRK
|
r3345 | by typing at the terminal:: | ||
Matthias Bussonnier
|
r22823 | |||
MinRK
|
r10575 | $ python -m IPython | ||
Dražen Lučanin
|
r10139 | |||
Rounak Banik
|
r22799 | Or see the `development installation docs | ||
stonebig
|
r24303 | <https://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_ | ||
Matthias Bussonnier
|
r22823 | for the latest revision on read the docs. | ||
Matthias Bussonnier
|
r22710 | |||
Documentation and installation instructions for older version of IPython can be | ||||
Matthias Bussonnier
|
r24425 | found on the `IPython website <https://ipython.org/documentation.html>`_ | ||
Matthias Bussonnier
|
r22823 | |||
IPython requires Python version 3 or above | ||||
========================================== | ||||
Starting with version 6.0, IPython does not support Python 2.7, 3.0, 3.1, or | ||||
3.2. | ||||
For a version compatible with Python 2.7, please install the 5.x LTS Long Term | ||||
Support version. | ||||
If you are encountering this error message you are likely trying to install or | ||||
use IPython from source. You need to checkout the remote 5.x branch. If you are | ||||
Matthias Bussonnier
|
r24266 | using git the following should work:: | ||
Matthias Bussonnier
|
r22823 | |||
$ git fetch origin | ||||
Thomas Ballinger
|
r23813 | $ git checkout 5.x | ||
Matthias Bussonnier
|
r22823 | |||
If you encounter this error message with a regular install of IPython, then you | ||||
likely need to update your package manager, for example if you are using `pip` | ||||
Matthias Bussonnier
|
r24266 | check the version of pip with:: | ||
Matthias Bussonnier
|
r22823 | |||
$ pip --version | ||||
Matthias Bussonnier
|
r23540 | You will need to update pip to the version 9.0.1 or greater. If you are not using | ||
Matthias Bussonnier
|
r22823 | pip, please inquiry with the maintainers of the package for your package | ||
manager. | ||||
For more information see one of our blog posts: | ||||
Gabriel Potter
|
r24891 | https://blog.jupyter.org/release-of-ipython-5-0-8ce60b8d2e8e | ||
Matthias Bussonnier
|
r22823 | |||
As well as the following Pull-Request for discussion: | ||||
https://github.com/ipython/ipython/pull/9900 | ||||
Matthias Bussonnier
|
r23540 | |||
This error does also occur if you are invoking ``setup.py`` directly – which you | ||||
should not – or are using ``easy_install`` If this is the case, use ``pip | ||||
Christopher Moura
|
r24662 | install .`` instead of ``setup.py install`` , and ``pip install -e .`` instead | ||
Matthias Bussonnier
|
r23540 | of ``setup.py develop`` If you are depending on IPython as a dependency you may | ||
also want to have a conditional dependency on IPython depending on the Python | ||||
version:: | ||||
install_req = ['ipython'] | ||||
if sys.version_info[0] < 3 and 'bdist_wheel' not in sys.argv: | ||||
install_req.remove('ipython') | ||||
install_req.append('ipython<6') | ||||
setup( | ||||
... | ||||
install_requires=install_req | ||||
) | ||||
Matthias Bussonnier
|
r25254 | |||
Alternatives to IPython | ||||
======================= | ||||
IPython may not be to your taste; if that's the case there might be similar | ||||
project that you might want to use: | ||||
Rakessh Roshan
|
r27336 | - The classic Python REPL. | ||
Matthias Bussonnier
|
r25254 | - `bpython <https://bpython-interpreter.org/>`_ | ||
- `mypython <https://www.asmeurer.com/mypython/>`_ | ||||
Rakessh Roshan
|
r27336 | - `ptpython and ptipython <https://pypi.org/project/ptpython/>`_ | ||
- `Xonsh <https://xon.sh/>`_ | ||||
Terry Davis
|
r25428 | |||
Ignoring commits with git blame.ignoreRevsFile | ||||
============================================== | ||||
As of git 2.23, it is possible to make formatting changes without breaking | ||||
``git blame``. See the `git documentation | ||||
<https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_ | ||||
for more details. | ||||
To use this feature you must: | ||||
- Install git >= 2.23 | ||||
- Configure your local git repo by running: | ||||
- POSIX: ``tools\configure-git-blame-ignore-revs.sh`` | ||||
- Windows: ``tools\configure-git-blame-ignore-revs.bat`` | ||||