##// END OF EJS Templates
Fix broken download URL for PyPI in setup call, minor readme updates.
Fernando Perez -
Show More
@@ -1,123 +1,125 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Release data for the IPython project."""
2 """Release data for the IPython project."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (c) 2008-2011, IPython Development Team.
5 # Copyright (c) 2008-2011, IPython Development Team.
6 # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu>
6 # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu>
7 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
7 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
8 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
8 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
9 #
9 #
10 # Distributed under the terms of the Modified BSD License.
10 # Distributed under the terms of the Modified BSD License.
11 #
11 #
12 # The full license is in the file COPYING.txt, distributed with this software.
12 # The full license is in the file COPYING.txt, distributed with this software.
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14
14
15 # Name of the package for release purposes. This is the name which labels
15 # Name of the package for release purposes. This is the name which labels
16 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
16 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
17 name = 'ipython'
17 name = 'ipython'
18
18
19 # IPython version information. An empty _version_extra corresponds to a full
19 # IPython version information. An empty _version_extra corresponds to a full
20 # release. 'dev' as a _version_extra string means this is a development
20 # release. 'dev' as a _version_extra string means this is a development
21 # version
21 # version
22 _version_major = 0
22 _version_major = 0
23 _version_minor = 12
23 _version_minor = 12
24 _version_micro = '' # use '' for first of series, number for 1 and above
24 _version_micro = '' # use '' for first of series, number for 1 and above
25 _version_extra = 'dev'
25 _version_extra = 'dev'
26 #_version_extra = '' # Uncomment this for full releases
26 #_version_extra = '' # Uncomment this for full releases
27
27
28 # Construct full version string from these.
28 # Construct full version string from these.
29 _ver = [_version_major, _version_minor]
29 _ver = [_version_major, _version_minor]
30 if _version_micro:
30 if _version_micro:
31 _ver.append(_version_micro)
31 _ver.append(_version_micro)
32 if _version_extra:
32 if _version_extra:
33 _ver.append(_version_extra)
33 _ver.append(_version_extra)
34
34
35 __version__ = '.'.join(map(str, _ver))
35 __version__ = '.'.join(map(str, _ver))
36
36
37 version = __version__ # backwards compatibility name
37 version = __version__ # backwards compatibility name
38
38
39 description = "An interactive computing environment for Python"
39 description = "IPython: Productive Interactive Computing"
40
40
41 long_description = \
41 long_description = \
42 """
42 """
43 The goal of IPython is to create a comprehensive environment for
43 IPython provides a rich toolkit to help you make the most out of using Python
44 interactive and exploratory computing. To support this goal, IPython
44 interactively. Its main components are:
45 has two main components:
46
45
47 * An enhanced interactive Python shell.
46 * Powerful interactive Python shells (terminal- and Qt-based).
47 * Support for interactive data visualization and use of GUI toolkits.
48 * Flexible, embeddable interpreters to load into your own projects.
49 * Tools for high level and interactive parallel computing.
48
50
49 * An architecture for interactive parallel computing.
51 The enhanced interactive Python shells have the following main features:
50
51 The enhanced interactive Python shell has the following main features:
52
52
53 * Comprehensive object introspection.
53 * Comprehensive object introspection.
54
54
55 * Input history, persistent across sessions.
55 * Input history, persistent across sessions.
56
56
57 * Caching of output results during a session with automatically generated
57 * Caching of output results during a session with automatically generated
58 references.
58 references.
59
59
60 * Readline based name completion.
60 * Readline based name completion.
61
61
62 * Extensible system of 'magic' commands for controlling the environment and
62 * Extensible system of 'magic' commands for controlling the environment and
63 performing many tasks related either to IPython or the operating system.
63 performing many tasks related either to IPython or the operating system.
64
64
65 * Configuration system with easy switching between different setups (simpler
65 * Configuration system with easy switching between different setups (simpler
66 than changing $PYTHONSTARTUP environment variables every time).
66 than changing $PYTHONSTARTUP environment variables every time).
67
67
68 * Session logging and reloading.
68 * Session logging and reloading.
69
69
70 * Extensible syntax processing for special purpose situations.
70 * Extensible syntax processing for special purpose situations.
71
71
72 * Access to the system shell with user-extensible alias system.
72 * Access to the system shell with user-extensible alias system.
73
73
74 * Easily embeddable in other Python programs and wxPython GUIs.
74 * Easily embeddable in other Python programs and wxPython GUIs.
75
75
76 * Integrated access to the pdb debugger and the Python profiler.
76 * Integrated access to the pdb debugger and the Python profiler.
77
77
78 The parallel computing architecture has the following main features:
78 The parallel computing architecture has the following main features:
79
79
80 * Quickly parallelize Python code from an interactive Python/IPython session.
80 * Quickly parallelize Python code from an interactive Python/IPython session.
81
81
82 * A flexible and dynamic process model that be deployed on anything from
82 * A flexible and dynamic process model that be deployed on anything from
83 multicore workstations to supercomputers.
83 multicore workstations to supercomputers.
84
84
85 * An architecture that supports many different styles of parallelism, from
85 * An architecture that supports many different styles of parallelism, from
86 message passing to task farming.
86 message passing to task farming.
87
87
88 * Both blocking and fully asynchronous interfaces.
88 * Both blocking and fully asynchronous interfaces.
89
89
90 * High level APIs that enable many things to be parallelized in a few lines
90 * High level APIs that enable many things to be parallelized in a few lines
91 of code.
91 of code.
92
92
93 * Share live parallel jobs with other users securely.
93 * Share live parallel jobs with other users securely.
94
94
95 * Dynamically load balanced task farming system.
95 * Dynamically load balanced task farming system.
96
96
97 * Robust error handling in parallel code.
97 * Robust error handling in parallel code.
98
98
99 The latest development version is always available from IPython's `GitHub
99 The latest development version is always available from IPython's `GitHub
100 site <http://github.com/ipython>`_.
100 site <http://github.com/ipython>`_.
101 """
101 """
102
102
103 license = 'BSD'
103 license = 'BSD'
104
104
105 authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'),
105 authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'),
106 'Janko' : ('Janko Hauser','jhauser@zscout.de'),
106 'Janko' : ('Janko Hauser','jhauser@zscout.de'),
107 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'),
107 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'),
108 'Ville' : ('Ville Vainio','vivainio@gmail.com'),
108 'Ville' : ('Ville Vainio','vivainio@gmail.com'),
109 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'),
109 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'),
110 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com')
110 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com')
111 }
111 }
112
112
113 author = 'The IPython Development Team'
113 author = 'The IPython Development Team'
114
114
115 author_email = 'ipython-dev@scipy.org'
115 author_email = 'ipython-dev@scipy.org'
116
116
117 url = 'http://ipython.org'
117 url = 'http://ipython.org'
118
118
119 download_url = 'http://ipython.scipy.org/dist'
119 # This will only be valid for actual releases sent to PyPI, but that's OK since
120 # those are the ones we want pip/easy_install to be able to find.
121 download_url = 'http://archive.ipython.org/release/%s' % version
120
122
121 platforms = ['Linux','Mac OSX','Windows XP/2000/NT','Windows 95/98/ME']
123 platforms = ['Linux','Mac OSX','Windows XP/2000/NT']
122
124
123 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed']
125 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed']
@@ -1,33 +1,33 b''
1 ==============
1 ===========================================
2 IPython README
2 IPython: Productive Interactive Computing
3 ==============
3 ===========================================
4
4
5 Overview
5 Overview
6 ========
6 ========
7
7
8 Welcome to IPython. Our full documentation can be found in the ``docs/dist``
8 Welcome to IPython. Our full documentation, including PDF versions of our
9 subdirectory in ``.html`` and ``.pdf`` formats, also available online at our
9 manual, is available on `our website <http://ipython.org/documentation.html>`_;
10 `docs repo <http://ipython.github.com/ipython-doc>`_. The ``docs/source`` directory
10 if you downloaded a built source distribution the ``docs/html`` directory
11 contains the plaintext version of these manuals.
11 contains an HTML version of the manual. The ``docs/source`` directory contains
12 the plaintext version of these manuals.
12
13
13
14
14 Dependencies and supported Python versions
15 Dependencies and supported Python versions
15 ==========================================
16 ==========================================
16
17
17 For full details, see the installation section of the manual. The basic parts
18 For full details, see the installation section of the manual. The basic parts
18 of IPython only need the Python standard library, but much of its more advanced
19 of IPython only need the Python standard library, but much of its more advanced
19 functionality requires extra packages.
20 functionality requires extra packages.
20
21
21 Officially, IPython requires Python version 2.6 or 2.7. An experimental port
22 Officially, IPython requires Python version 2.6 or 2.7. A separate repository
22 of IPython to Python 3.x is being developed at
23 contains our Python 3 version, as explained `in our wiki
23 http://github.com/ipython/ipython-py3k.
24 <http://wiki.ipython.org/Python_3>`_.
24
25
25
26
26 Instant running
27 Instant running
27 ===============
28 ===============
28
29
29 You can run IPython from this directory without even installing it system-wide
30 You can run IPython from this directory without even installing it system-wide
30 by typing at the terminal::
31 by typing at the terminal::
31
32
32 $ python ipython.py
33 $ python ipython.py
33
General Comments 0
You need to be logged in to leave comments. Login now