Updated docs and release tools

IPython/Release.py

@@ -1,99 +1,99 b''
 # -*- coding: utf-8 -*-
 """Release data for the IPython project.
 
 $Id: Release.py 3002 2008-02-01 07:17:00Z fperez $"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
 #
 #       Copyright (c) 2001 Janko Hauser <[e-mail]> and Nathaniel Gray
 #       <[e-mail]>
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
 # Name of the package for release purposes.  This is the name which labels
 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
 name = 'ipython'
 
 # For versions with substrings (like 0.6.16.svn), use an extra . to separate
 # the new substring.  We have to avoid using either dashes or underscores,
 # because bdist_rpm does not accept dashes (an RPM) convention, and
 # bdist_deb does not accept underscores (a Debian convention).
 
 development = False    # change this to False to do a release
-version_base = '0.9.beta'
+version_base = '0.9.beta2'
 branch = 'ipython'
-revision = '1099'
+revision = '1103'
 
 if development:
     if branch == 'ipython':
         version = '%s.bzr.r%s' % (version_base, revision)
     else:
         version = '%s.bzr.r%s.%s' % (version_base, revision, branch)
 else:
     version = version_base
 
 
 description = "Tools for interactive development in Python."
 
 long_description = \
 """
 IPython provides a replacement for the interactive Python interpreter with
 extra functionality.
 
 Main features:
 
  * Comprehensive object introspection.
 
  * Input history, persistent across sessions.
 
  * Caching of output results during a session with automatically generated
    references.
 
  * Readline based name completion.
 
  * Extensible system of 'magic' commands for controlling the environment and
    performing many tasks related either to IPython or the operating system.
 
  * 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.
 
  * Integrated access to the pdb debugger and the Python profiler. 
 
  The latest development version is always available at the IPython subversion
  repository_.
 
 .. _repository: http://ipython.scipy.org/svn/ipython/ipython/trunk#egg=ipython-dev
  """
 
 license = 'BSD'
 
 authors = {'Fernando' : ('Fernando Perez','[e-mail]'),
            'Janko'    : ('Janko Hauser','[e-mail]'),
            'Nathan'   : ('Nathaniel Gray','[e-mail]'),
            'Ville'    : ('Ville Vainio','[e-mail]'),
            'Brian'    : ('Brian E Granger', '[e-mail]'),
            'Min'      : ('Min Ragan-Kelley', '[e-mail]')
            }
 
 author = 'The IPython Development Team'
 
 author_email = '[e-mail]'
 
 url = 'http://ipython.scipy.org'
 
 download_url = 'http://ipython.scipy.org/dist'
 
 platforms = ['Linux','Mac OSX','Windows XP/2000/NT','Windows 95/98/ME']
 
 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed']

docs/source/changes.txt

@@ -1,200 +1,247 b''
 .. _changes:
 
 ==========
 What's new
 ==========
 
 .. contents::
+..
+    1  Release 0.9
+      1.1  New features
+      1.2  Bug fixes
+      1.3  Backwards incompatible changes
+      1.4  Changes merged in from IPython1
+        1.4.1  New features
+        1.4.2  Bug fixes
+        1.4.3  Backwards incompatible changes
+    2  Release 0.8.4
+    3  Release 0.8.2
+    4  Release 0.8.3
+    5  Older releases
+..
+
 
 Release 0.9
 ===========
 
 New features
 ------------
 
+* The Editor synchronization work by Vivian De Smedt has been merged in.  This
+  code adds a number of new editor hooks to synchronize with editors under
+  Windows.
+
+* A new, still experimental but highly functional, WX shell by Gael Varoquaux.
+  This work was sponsored by Enthought, and while it's still very new, it is
+  based on a more cleanly organized arhictecture of the various IPython
+  components.  We will continue to develop this over the next few releases as a
+  model for GUI components that use IPython.
+
+* Another GUI frontend, Cocoa based (Cocoa is the OSX native GUI framework),
+  authored by Barry Wark.  Currently the WX and the Cocoa ones have slightly
+  different internal organizations, but the whole team is working on finding
+  what the right abstraction points are for a unified codebase.
+
+* As part of the frontend work, Barry Wark also implemented an experimental
+  event notification system that various ipython components can use.  In the
+  next release the implications and use patterns of this system regarding the
+  various GUI options will be worked out.
+
+* IPython finally has a full test system, that can test docstrings with
+  IPython-specific functionality.  There are still a few pieces missing for it
+  to be widely accessible to all users (so they can run the test suite at any
+  time and report problems), but it now works for the developers.  We are
+  working hard on continuing to improve it, as this was probably IPython's
+  major Achilles heel (the lack of proper test coverage made it effectively
+  impossible to do large-scale refactoring).
+
 	* The notion of a task has been completely reworked.  An `ITask` interface has
 	  been created.  This interface defines the methods that tasks need to implement.
 	  These methods are now responsible for things like submitting tasks and processing
 	  results.  There are two basic task types: :class:`IPython.kernel.task.StringTask`
 	  (this is the old `Task` object, but renamed) and the new 
 	  :class:`IPython.kernel.task.MapTask`, which is based on a function.
 	* A new interface, :class:`IPython.kernel.mapper.IMapper` has been defined to
 	  standardize the idea of a `map` method.  This interface has a single
 	  `map` method that has the same syntax as the built-in `map`.  We have also defined
 	  a `mapper` factory interface that creates objects that implement
 	  :class:`IPython.kernel.mapper.IMapper` for different controllers.  Both
 	  the multiengine and task controller now have mapping capabilties.
 	* The parallel function capabilities have been reworks.  The major changes are that
 	  i) there is now an `@parallel` magic that creates parallel functions, ii)
 	  the syntax for mulitple variable follows that of `map`, iii) both the
 	  multiengine and task controller now have a parallel function implementation.
 	* All of the parallel computing capabilities from `ipython1-dev` have been merged into
 	  IPython proper.  This resulted in the following new subpackages:  
 	  :mod:`IPython.kernel`, :mod:`IPython.kernel.core`, :mod:`IPython.config`,
 	  :mod:`IPython.tools` and :mod:`IPython.testing`.
 	* As part of merging in the `ipython1-dev` stuff, the `setup.py` script and friends
 	  have been completely refactored.  Now we are checking for dependencies using
 	  the approach that matplotlib uses.
 	* The documentation has been completely reorganized to accept the documentation
 	  from `ipython1-dev`.
 	* We have switched to using Foolscap for all of our network protocols in
 	  :mod:`IPython.kernel`.  This gives us secure connections that are both encrypted
 	  and authenticated.
 	* We have a brand new `COPYING.txt` files that describes the IPython license
 	  and copyright.  The biggest change is that we are putting "The IPython
 	  Development Team" as the copyright holder.  We give more details about exactly
 	  what this means in this file.  All developer should read this and use the new
 	  banner in all IPython source code files.
 	* sh profile: ./foo runs foo as system command, no need to do !./foo anymore
 	* String lists now support 'sort(field, nums = True)' method (to easily
 	  sort system command output). Try it with 'a = !ls -l ; a.sort(1, nums=1)'
 	* '%cpaste foo' now assigns the pasted block as string list, instead of string
 	* The ipcluster script now run by default with no security.  This is done because
 	  the main usage of the script is for starting things on localhost.  Eventually
 	  when ipcluster is able to start things on other hosts, we will put security
 	  back.
 	* 'cd --foo' searches directory history for string foo, and jumps to that dir.
 	  Last part of dir name is checked first. If no matches for that are found,
 	  look at the whole path.
 
 Bug fixes
 ---------
 
 	* The colors escapes in the multiengine client are now turned off on win32 as they
 	  don't print correctly.
 	* The :mod:`IPython.kernel.scripts.ipengine` script was exec'ing mpi_import_statement
 	  incorrectly, which was leading the engine to crash when mpi was enabled.
 	* A few subpackages has missing `__init__.py` files.
 	* The documentation is only created is Sphinx is found.  Previously, the `setup.py`
 	  script would fail if it was missing.
 	* Greedy 'cd' completion has been disabled again (it was enabled in 0.8.4)
           
 
 Backwards incompatible changes
 ------------------------------
 
+* In ipapi, the :func:`make_user_ns` function has been replaced with
+  :func:`make_user_namespaces`, to support dict subclasses in namespace
+  creation.
+
 	* :class:`IPython.kernel.client.Task` has been renamed
 	  :class:`IPython.kernel.client.StringTask` to make way for new task types.
 	* The keyword argument `style` has been renamed `dist` in `scatter`, `gather`
 	  and `map`.
 	* Renamed the values that the rename `dist` keyword argument can have from
 	  `'basic'` to `'b'`.
 	* IPython has a larger set of dependencies if you want all of its capabilities.
 	  See the `setup.py` script for details.
 	* The constructors for :class:`IPython.kernel.client.MultiEngineClient` and 
 	  :class:`IPython.kernel.client.TaskClient` no longer take the (ip,port) tuple.
 	  Instead they take the filename of a file that contains the FURL for that
 	  client.  If the FURL file is in your IPYTHONDIR, it will be found automatically
 	  and the constructor can be left empty.
 	* The asynchronous clients in :mod:`IPython.kernel.asyncclient` are now created 
 	  using the factory functions :func:`get_multiengine_client` and 
 	  :func:`get_task_client`.  These return a `Deferred` to the actual client.
 	* The command line options to `ipcontroller` and `ipengine` have changed to
 	  reflect the new Foolscap network protocol and the FURL files.  Please see the
 	  help for these scripts for details.
 	* The configuration files for the kernel have changed because of the Foolscap stuff.
 	  If you were using custom config files before, you should delete them and regenerate
 	  new ones.
 
 Changes merged in from IPython1
 -------------------------------
 
 New features
 ............
 
 	* Much improved ``setup.py`` and ``setupegg.py`` scripts.  Because Twisted
 	  and zope.interface are now easy installable, we can declare them as dependencies
 	  in our setupegg.py script.
 	* IPython is now compatible with Twisted 2.5.0 and 8.x.
 	* Added a new example of how to use :mod:`ipython1.kernel.asynclient`.
 	* Initial draft of a process daemon in :mod:`ipython1.daemon`.  This has not
 	  been merged into IPython and is still in `ipython1-dev`.
 	* The ``TaskController`` now has methods for getting the queue status.
 	* The ``TaskResult`` objects not have information about how long the task
 	  took to run.
 	* We are attaching additional attributes to exceptions ``(_ipython_*)`` that 
 	  we use to carry additional info around.
 	* New top-level module :mod:`asyncclient` that has asynchronous versions (that
 	  return deferreds) of the client classes.  This is designed to users who want
 	  to run their own Twisted reactor
 	* All the clients in :mod:`client` are now based on Twisted.  This is done by 
 	  running the Twisted reactor in a separate thread and using the
 	  :func:`blockingCallFromThread` function that is in recent versions of Twisted.
 	* Functions can now be pushed/pulled to/from engines using
 	  :meth:`MultiEngineClient.push_function` and :meth:`MultiEngineClient.pull_function`.
 	* Gather/scatter are now implemented in the client to reduce the work load
 	  of the controller and improve performance.
 	* Complete rewrite of the IPython docuementation.  All of the documentation
 	  from the IPython website has been moved into docs/source as restructured
 	  text documents.  PDF and HTML documentation are being generated using 
 	  Sphinx.
 	* New developer oriented documentation: development guidelines and roadmap. 
 	* Traditional ``ChangeLog`` has been changed to a more useful ``changes.txt`` file
 	  that is organized by release and is meant to provide something more relevant
 	  for users.
 
 Bug fixes
 .........
 
 	* Created a proper ``MANIFEST.in`` file to create source distributions.
 	* Fixed a bug in the ``MultiEngine`` interface.  Previously, multi-engine 
 	  actions were being collected with a :class:`DeferredList` with 
 	  ``fireononeerrback=1``.  This meant that methods were returning 
 	  before all engines had given their results.  This was causing extremely odd 
 	  bugs in certain cases. To fix this problem, we have 1) set 
 	  ``fireononeerrback=0`` to make sure all results (or exceptions) are in 
 	  before returning and 2) introduced a :exc:`CompositeError` exception 
 	  that wraps all of the engine exceptions.  This is a huge change as it means 
 	  that users will have to catch :exc:`CompositeError` rather than the actual
 	  exception.
 
 Backwards incompatible changes
 ..............................
 
 	* All names have been renamed to conform to the lowercase_with_underscore
 	  convention.  This will require users to change references to all names like
 	  ``queueStatus`` to ``queue_status``.
 	* Previously, methods like :meth:`MultiEngineClient.push` and    	
 	  :meth:`MultiEngineClient.push` used ``*args`` and ``**kwargs``.  This was 
 	  becoming a problem as we weren't able to introduce new keyword arguments into
 	  the API.  Now these methods simple take a dict or sequence.  This has also allowed
 	  us to get rid of the ``*All`` methods like :meth:`pushAll` and :meth:`pullAll`.
 	  These things are now handled with the ``targets`` keyword argument that defaults
 	  to ``'all'``.
 	* The :attr:`MultiEngineClient.magicTargets` has been renamed to
 	  :attr:`MultiEngineClient.targets`. 
 	* All methods in the MultiEngine interface now accept the optional keyword argument
 	  ``block``.
 	* Renamed :class:`RemoteController` to :class:`MultiEngineClient` and 
 	  :class:`TaskController` to :class:`TaskClient`.
 	* Renamed the top-level module from :mod:`api` to :mod:`client`.
 	* Most methods in the multiengine interface now raise a :exc:`CompositeError` exception
 	  that wraps the user's exceptions, rather than just raising the raw user's exception.
 	* Changed the ``setupNS`` and ``resultNames`` in the ``Task`` class to ``push`` 
 	  and ``pull``.
 
 Release 0.8.4
 =============
 
 Someone needs to describe what went into 0.8.4.
 
 Release 0.8.2
 =============
 
 * %pushd/%popd behave differently; now "pushd /foo" pushes CURRENT directory 
   and jumps to /foo. The current behaviour is closer to the documented 
   behaviour, and should not trip anyone.
   
 Release 0.8.3
 =============
   
 * pydb is now disabled by default (due to %run -d problems). You can enable
   it by passing -pydb command line argument to IPython. Note that setting
   it in config file won't work.
 
 Older releases
 ==============
 
 Changes in earlier releases of IPython are described in the older file ``ChangeLog``.  
 Please refer to this document for details.
 

docs/source/conf.py

@@ -1,166 +1,180 b''
 # -*- coding: utf-8 -*-
 #
 # IPython documentation build configuration file, created by
 # sphinx-quickstart on Thu May  8 16:45:02 2008.
+
+# NOTE: This file has been edited manually from the auto-generated one from
+# sphinx.  Do NOT delete and re-generate.  If any changes from sphinx are
+# needed, generate a scratch one and merge by hand any new fields needed.
+
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
 # The contents of this file are pickled, so don't put values in the namespace
 # that aren't pickleable (module imports are okay, they're removed automatically).
 #
 # All configuration values have a default value; values that are commented out
 # serve to show the default value.
 
 import sys, os
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 #sys.path.append(os.path.abspath('some/directory'))
 
+# We load the ipython release info into a dict by explicit execution
+iprelease = {}
+execfile('../../IPython/Release.py',iprelease)
+
 # General configuration
 # ---------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 #extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.txt'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General substitutions.
 project = 'IPython'
 copyright = '2008, The IPython Development Team'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
-# The short X.Y version.
-version = '0.9'
 # The full version, including alpha/beta/rc tags.
-release = '0.9.beta1'
+release = iprelease['version']
+# The short X.Y version.
+version = '.'.join(release.split('.',2)[:2])
+
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
 
 # List of directories, relative to source directories, that shouldn't be searched
 # for source files.
 #exclude_dirs = []
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 #add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 
 # Options for HTML output
 # -----------------------
 
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
 html_style = 'default.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
 #html_logo = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}
 
 # If false, no module index is generated.
 #html_use_modindex = True
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
 #html_copy_source = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'IPythondoc'
 
 
 # Options for LaTeX output
 # ------------------------
 
 # The paper size ('letter' or 'a4').
 latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
 latex_font_size = '11pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 
 latex_documents = [ ('index', 'IPython.tex', 'IPython Documentation',
                      ur"""Brian Granger, Fernando Pérez and Ville Vainio\\
                      \ \\
                      With contributions from:\\
                      Benjamin Ragan-Kelley.""",
                      'manual'),
                     ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 #latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 #latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
 
 # If false, no module index is generated.
 #latex_use_modindex = True
+
+
+# Cleanup: delete release info to avoid pickling errors from sphinx
+del iprelease