README.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. image:: https://codecov.io/github/ipython/ipython/coverage.svg?branch=master
  2. :target: https://codecov.io/github/ipython/ipython?branch=master
  3. .. image:: https://img.shields.io/pypi/dm/IPython.svg
  4. :target: https://pypi.python.org/pypi/ipython
  5. .. image:: https://img.shields.io/pypi/v/IPython.svg
  6. :target: https://pypi.python.org/pypi/ipython
  7. .. image:: https://img.shields.io/travis/ipython/ipython.svg
  8. :target: https://travis-ci.org/ipython/ipython
  9. ===========================================
  10. IPython: Productive Interactive Computing
  11. ===========================================
  12. Overview
  13. ========
  14. Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io
  15. <https://ipython.readthedocs.io/en/stable/>`_ and contain information on how to install, use
  16. contribute to the project.
  17. Officially, IPython requires Python version 2.7, or 3.3 and above.
  18. IPython 1.x is the last IPython version to support Python 2.6 and 3.2.
  19. The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*.
  20. See the `Jupyter installation docs <http://jupyter.readthedocs.io/en/latest/install.html>`__
  21. if you want to use these.
  22. Developement and Instant runnimg
  23. ================================
  24. You can find the latest version of the development documentation on `readthedocs
  25. <http://ipython.readthedocs.io/en/latest/>`_.
  26. You can run IPython from this directory without even installing it system-wide
  27. by typing at the terminal::
  28. $ python -m IPython
  29. Or see the `developement installation docs
  30. <http://ipython.readthedocs.io/en/latest/install/install.html#installing-the-development-version>`_
  31. for the latest revision on read the docs.
  32. Documentation and installation instructions for older version of IPython can be
  33. found on the `IPython website <http://ipython.org/documentation.html>`_