upstream/ipython Files · README.rst · RhodeCode Free Hosting

Merge pull request from ipython/Carreau-patch-1-2...

Merge pull request from ipython/Carreau-patch-1-2 Typo in sympyprinting `as move`-> `has moved`

Matthias Bussonnier - - Load All Authors

File last commit:

r19865:6851664a


                r21496:b754d5ea

Download file

             README.rst
        
                    80 lines
            
             | 2.6 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / README.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Matthias Bussonnier
    
readme badges

              r19865
            
      .. image:: https://img.shields.io/coveralls/ipython/ipython.svg 

          :target: https://coveralls.io/r/ipython/ipython?branch=master

      .. image:: https://img.shields.io/pypi/dm/IPython.svg           

          :target: https://pypi.python.org/pypi/ipython

      .. image:: https://img.shields.io/pypi/v/IPython.svg            

          :target: https://pypi.python.org/pypi/ipython

      .. image:: https://img.shields.io/travis/ipython/ipython.svg    

          :target: https://travis-ci.org/ipython/ipython

        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
            
        Fernando Perez
    
Minor doc updates, ensure README is in final tarball.

              r6599
            
      Welcome to IPython.  Our full documentation is available on `our website

      <http://ipython.org/documentation.html>`_; if you downloaded a built source

      distribution the ``docs/source`` directory contains the plaintext version of

      these manuals.  If you have Sphinx installed, you can build them by typing

        Aaron Meurer
    
Make it more clear in the README how exactly to build the docs

              r7825
            
      ``cd docs; make html`` for local browsing.

        Brian Granger
    
Updated the main README.txt file to refect the 0.9 release.

              r1719
            
        Fernando Perez
    
Make it possible to run the tests from the source dir without installation....

              r2481
            
        Fernando Perez
    
Add a note about supported python versions to docs (and website)...

              r2573
            
      Dependencies and supported Python versions

      ==========================================

      For full details, see the installation section of the manual.  The basic parts

      of IPython only need the Python standard library, but much of its more advanced

      functionality requires extra packages.

        MinRK
    
update README with dropped 2.6 and 3.2 support...

              r12475
            
      Officially, IPython requires Python version 2.7, or 3.3 and above.

      IPython 1.x is the last IPython version to support Python 2.6 and 3.2.

        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
            
        Fernando Perez
    
Remove stale reference to iptest.py top-level script.

              r2536
            
      Instant running

      ===============

        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::

        Fernando Perez
    
Make it possible to run the tests from the source dir without installation....

              r2481
            
        MinRK
    
remove mention of `ipython.py` from README

              r10575
            
         $ python -m IPython

        Dražen Lučanin
    
quick dev installation instructions

              r10139
            
      Development installation

      ========================

      If you want to hack on certain parts, e.g. the IPython notebook, in a clean

      environment (such as a virtualenv) you can use ``pip`` to grab the necessary

      dependencies quickly::

        MinRK
    
update README with dropped 2.6 and 3.2 support...

              r12475
            
         $ git clone --recursive https://github.com/ipython/ipython.git

         $ cd ipython

        Ezequiel (Zac) Panepucci
    
update install instructions to use --user for pip

              r16278
            
         $ pip install -e ".[notebook]" --user

        Dražen Lučanin
    
quick dev installation instructions

              r10139
            
      This installs the necessary packages and symlinks IPython into your current

      environment so that you can work on your local repo copy and run it from anywhere::

         $ ipython notebook

        Kyle Kelley
    
Added missing s

              r10224
            
      The same process applies for other parts, such as the qtconsole (the

        Dražen Lučanin
    
quick dev installation instructions

              r10139
            
      ``extras_require`` attribute in the setup.py file lists all the possibilities).

        MinRK
    
mention git hooks in top-level readme

              r10558
            
      Git Hooks and Submodules

      ************************

      IPython now uses git submodules to ship its javascript dependencies.

      If you run IPython from git master, you may need to update submodules once in a while with::

          $ git submodule update

      or::

          $ python setup.py submodule

      We have some git hooks for helping keep your submodules always in sync,

      see our ``git-hooks`` directory for more info.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Matthias Bussonnier readme badges	r19865	.. image:: https://img.shields.io/coveralls/ipython/ipython.svg
		:target: https://coveralls.io/r/ipython/ipython?branch=master

		.. image:: https://img.shields.io/pypi/dm/IPython.svg
		:target: https://pypi.python.org/pypi/ipython

		.. image:: https://img.shields.io/pypi/v/IPython.svg
		:target: https://pypi.python.org/pypi/ipython

		.. image:: https://img.shields.io/travis/ipython/ipython.svg
		:target: https://travis-ci.org/ipython/ipython


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
Fernando Perez Minor doc updates, ensure README is in final tarball.	r6599	Welcome to IPython. Our full documentation is available on `our website
		<http://ipython.org/documentation.html>`_; if you downloaded a built source
		distribution the ``docs/source`` directory contains the plaintext version of
		these manuals. If you have Sphinx installed, you can build them by typing
Aaron Meurer Make it more clear in the README how exactly to build the docs	r7825	``cd docs; make html`` for local browsing.
Brian Granger Updated the main README.txt file to refect the 0.9 release.	r1719
Fernando Perez Make it possible to run the tests from the source dir without installation....	r2481
Fernando Perez Add a note about supported python versions to docs (and website)...	r2573	Dependencies and supported Python versions
		==========================================

		For full details, see the installation section of the manual. The basic parts
		of IPython only need the Python standard library, but much of its more advanced
		functionality requires extra packages.

MinRK update README with dropped 2.6 and 3.2 support...	r12475	Officially, IPython requires Python version 2.7, or 3.3 and above.
		IPython 1.x is the last IPython version to support Python 2.6 and 3.2.
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
Fernando Perez Remove stale reference to iptest.py top-level script.	r2536	Instant running
		===============
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::
Fernando Perez Make it possible to run the tests from the source dir without installation....	r2481
MinRK remove mention of `ipython.py` from README	r10575	$ python -m IPython
Dražen Lučanin quick dev installation instructions	r10139

		Development installation
		========================

		If you want to hack on certain parts, e.g. the IPython notebook, in a clean
		environment (such as a virtualenv) you can use ``pip`` to grab the necessary
		dependencies quickly::

MinRK update README with dropped 2.6 and 3.2 support...	r12475	$ git clone --recursive https://github.com/ipython/ipython.git
		$ cd ipython
Ezequiel (Zac) Panepucci update install instructions to use --user for pip	r16278	$ pip install -e ".[notebook]" --user
Dražen Lučanin quick dev installation instructions	r10139
		This installs the necessary packages and symlinks IPython into your current
		environment so that you can work on your local repo copy and run it from anywhere::

		$ ipython notebook

Kyle Kelley Added missing s	r10224	The same process applies for other parts, such as the qtconsole (the
Dražen Lučanin quick dev installation instructions	r10139	``extras_require`` attribute in the setup.py file lists all the possibilities).
MinRK mention git hooks in top-level readme	r10558
		Git Hooks and Submodules
		************************

		IPython now uses git submodules to ship its javascript dependencies.
		If you run IPython from git master, you may need to update submodules once in a while with::

		$ git submodule update

		or::

		$ python setup.py submodule

		We have some git hooks for helping keep your submodules always in sync,
		see our ``git-hooks`` directory for more info.