Merge pull request #11006 from Carreau/fix-ipython-spelling...
Merge pull request #11006 from Carreau/fix-ipython-spelling Fix IPython spelling

File last commit:

r23991:466bde2f
r24144:cc353b25 merge
Show More
README.rst
109 lines | 3.7 KiB | text/x-rst | RstLexer
Matthias Bussonnier
Remove coverall...
r21796 .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master
:target: https://codecov.io/github/ipython/ipython?branch=master
Matthias Bussonnier
readme badges
r19865
Carol Willing
Add an important directive for Py2/Py3 support
r23534 .. image:: https://img.shields.io/pypi/v/IPython.svg
Matthias Bussonnier
readme badges
r19865 :target: https://pypi.python.org/pypi/ipython
Carol Willing
Add an important directive for Py2/Py3 support
r23534 .. image:: https://img.shields.io/travis/ipython/ipython.svg
Matthias Bussonnier
readme badges
r19865 :target: https://travis-ci.org/ipython/ipython
Mradul Dubey
Update README.rst
r23720 .. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg
:target: https://www.codetriage.com/ipython/ipython/
Matthias Bussonnier
readme badges
r19865
Fernando Perez
Fix broken download URL for PyPI in setup call, minor readme updates.
r4459 ===========================================
IPython: Productive Interactive Computing
===========================================
fperez
Reorganized the directory for ipython/ to have its own dir, which is a bit...
r0
Brian E Granger
Cleaning up the IPython docs. I have removed old README files that were outdated and being maintained...
r1250 Overview
========
darren.dale
More testing Darren Dale user, test done still by fperez. Whitespace-only change.
r864
Matthias Bussonnier
Update readme instructions.
r22640 Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io
Rounak Banik
Update README.rst
r22799 <https://ipython.readthedocs.io/en/stable/>`_ and contains information on how to install, use and
Matthias Bussonnier
Update readme instructions.
r22640 contribute to the project.
Brian Granger
Updated the main README.txt file to refect the 0.9 release.
r1719
Thomas Kluyver
Make note about Py2 support not a directive
r23535 **IPython versions and Python Support**
Carol Willing
Add an important directive for Py2/Py3 support
r23534
Thomas Kluyver
Make note about Py2 support not a directive
r23535 **IPython 6** requires Python version 3.3 and above.
Carol Willing
Add an important directive for Py2/Py3 support
r23534
Thomas Kluyver
Make note about Py2 support not a directive
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
Add an important directive for Py2/Py3 support
r23534
Fernando Perez
Add a note about supported python versions to docs (and website)...
r2573
Thomas Kluyver
Update README wrt Jupyter...
r21596 The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
Matthias Bussonnier
Also update .ipynb examples and Readme
r22290 See the `Jupyter installation docs <http://jupyter.readthedocs.io/en/latest/install.html>`__
Thomas Kluyver
Update README wrt Jupyter...
r21596 if you want to use these.
Fernando Perez
Add a note about supported python versions to docs (and website)...
r2573
Aaron Meurer
Make it more clear in the README how exactly to build the docs
r7825
Matthias Bussonnier
Update readme instructions.
r22640
Matthias Bussonnier
Update README.rst
r22826 Development and Instant running
===============================
Matthias Bussonnier
Update readme instructions.
r22640
You can find the latest version of the development documentation on `readthedocs
Matthias Bussonnier
Improve our error messages for non compatibility.
r22823 <http://ipython.readthedocs.io/en/latest/>`_.
Fernando Perez
Make it possible to run the tests from the source dir without installation....
r2481
You can run IPython from this directory without even installing it system-wide
MinRK
README.txt -> README.rst
r3345 by typing at the terminal::
Matthias Bussonnier
Improve our error messages for non compatibility.
r22823
MinRK
remove mention of `ipython.py` from README
r10575 $ python -m IPython
Dražen Lučanin
quick dev installation instructions
r10139
Rounak Banik
Update README.rst
r22799 Or see the `development installation docs
Matthias Bussonnier
Link to the developer install instruction on readthedocs....
r22710 <http://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
Matthias Bussonnier
Improve our error messages for non compatibility.
r22823 for the latest revision on read the docs.
Matthias Bussonnier
Link to the developer install instruction on readthedocs....
r22710
Documentation and installation instructions for older version of IPython can be
found on the `IPython website <http://ipython.org/documentation.html>`_
Matthias Bussonnier
Improve our error messages for non compatibility.
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
using git the following should work:
$ git fetch origin
Thomas Ballinger
Correct suggested git commands for checkout 5.x...
r23813 $ git checkout 5.x
Matthias Bussonnier
Improve our error messages for non compatibility.
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`
check the version of pip with
$ pip --version
Matthias Bussonnier
Complete readme with oaw to conditionally depend on IPython versions.
r23540 You will need to update pip to the version 9.0.1 or greater. If you are not using
Matthias Bussonnier
Improve our error messages for non compatibility.
r22823 pip, please inquiry with the maintainers of the package for your package
manager.
For more information see one of our blog posts:
http://blog.jupyter.org/2016/07/08/ipython-5-0-released/
As well as the following Pull-Request for discussion:
https://github.com/ipython/ipython/pull/9900
Matthias Bussonnier
Complete readme with oaw to conditionally depend on IPython versions.
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
Thomas Hisch
fix minor typo in README.rst
r23542 install .`` (instead of ``setup.py install`` , and ``pip install -e .`` instead
Matthias Bussonnier
Complete readme with oaw to conditionally depend on IPython versions.
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
)