Added compatibility layer for Shell/ipapi/iplib.

These 3 top-level modules have been moved to core.  But, to ease the
transition to their new location, we have re-created these modules
at the top-level.  The new top-level modules print a warning statement
and simple import the moved modules for now.  In the long run, we can
use these for further compatibility related things.

IPython/Shell.py

@@ -0,0 +1,29 b''
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+A backwards compatibility layer for IPython.Shell.
+
+Previously, IPython had an IPython.Shell module.  IPython.Shell has been moved
+to IPython.core.shell and is being refactored.  This new module is provided
+for backwards compatability.  We strongly encourage everyone to start using
+the new code in IPython.core.shell.
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+from warnings import warn
+
+msg = """
+This module (IPython.Shell) has been moved to a new location
+(IPython.core.shell) and is being refactored.  Please update your code
+to use the new IPython.core.shell module"""
+
+warn(msg, category=DeprecationWarning, stacklevel=1)
+
+from IPython.core.shell import *
+

IPython/ipapi.py

@@ -0,0 +1,29 b''
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+A backwards compatibility layer for IPython.ipapi.
+
+Previously, IPython had an IPython.ipapi module.  IPython.ipapi has been moved
+to IPython.core.ipapi and is being refactored.  This new module is provided
+for backwards compatability.  We strongly encourage everyone to start using
+the new code in IPython.core.ipapi.
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+from warnings import warn
+
+msg = """
+This module (IPython.ipapi) has been moved to a new location
+(IPython.core.ipapi) and is being refactored.  Please update your code
+to use the new IPython.core.ipapi module"""
+
+warn(msg, category=DeprecationWarning, stacklevel=1)
+
+from IPython.core.ipapi import *
+

IPython/iplib.py

@@ -0,0 +1,28 b''
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+A backwards compatibility layer for IPython.iplib.
+
+Previously, IPython had an IPython.iplib module.  IPython.iplib has been moved
+to IPython.core.iplib and is being refactored.  This new module is provided
+for backwards compatability.  We strongly encourage everyone to start using
+the new code in IPython.core.iplib.
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2009  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+from warnings import warn
+
+msg = """
+This module (IPython.iplib) has been moved to a new location
+(IPython.core.iplib) and is being refactored.  Please update your code
+to use the new IPython.core.iplib module"""
+
+warn(msg, category=DeprecationWarning, stacklevel=1)
+
+from IPython.core.iplib import *

docs/source/development/reorg.txt

@@ -1,266 +1,274 b''
 =============================
 IPython module reorganization
-=============================
+============================='
 
-Currently, IPython has many top-level modules that serve many different purposes.
-The lack of organization make it very difficult for developers to work on IPython
-and understand its design. This document contains notes about how we will reorganize
-the modules into sub-packages.
+Currently, IPython has many top-level modules that serve many different
+purposes. The lack of organization make it very difficult for developers to
+work on IPython and understand its design. This document contains notes about
+how we will reorganize the modules into sub-packages.
 
 .. warning::
 
     This effort will possibly break third party packages that use IPython as
     a library or hack on the IPython internals.
 
 .. warning::
 
     This effort will result in the removal from IPython of certain modules
     that are not used anymore, don't currently work, are unmaintained, etc.
 
 
 Current subpackges
 ==================
 
 IPython currently has the following sub-packages:
 
 * :mod:`IPython.config`
 
 * :mod:`IPython.Extensions`
 
 * :mod:`IPython.external`
 
 * :mod:`IPython.frontend`
 
 * :mod:`IPython.gui`
 
 * :mod:`IPython.kernel`
 
 * :mod:`IPython.testing`
 
 * :mod:`IPython.tests`
 
 * :mod:`IPython.tools`
 
 * :mod:`IPython.UserConfig`
 
 New Subpackages to be created
 =============================
 
 We propose to create the following new sub-packages:
 
 * :mod:`IPython.core`. This sub-package will contain the core of the IPython
   interpreter, but none of its extended capabilities.
 
 * :mod:`IPython.lib`. IPython has many extended capabilities that are not part
   of the IPython core. These things will go here.  Any better names than 
   :mod:`IPython.lib`?
 
 * :mod:`IPython.utils`. This sub-package will contain anything that might
   eventually be found in the Python standard library, like things in
   :mod:`genutils`. Each sub-module in this sub-package should contain
   functions and classes that serve a single purpose.
 
 * :mod:`IPython.deathrow`. This is for code that is untested and/or rotting
   and needs to be removed from IPython. Eventually all this code will either
   i) be revived by someone willing to maintain it with tests and docs and
   re-included into IPython or 2) be removed from IPython proper, but put into
   a separate top-level (not IPython) package that we keep around. No new code
   will be allowed here.
 
 * :mod:`IPython.quarantine`.  This is for code that doesn't meet IPython's 
   standards, but that we plan on keeping.  To be moved out of this sub-package
   a module needs to have a maintainer, tests and documentation.
 
-Prodecure
+Prodedure
 =========
 
 1. Move the file to its new location with its new name.
 2. Rename all import statements to reflect the change.
 3. Run PyFlakes on each changes module.
 3. Add tests/test_imports.py to test it.
 
-Need to modify iptests to properly skip modules that are no longer top
-level modules.
+Status
+======
+
+The new subpackages have been created and the top-level modules have been
+moved and renamed. Import tests have been created for all of the moved and
+renamed modules. The build infrastructure (setup.py and friends) have been
+updated and tested on Mac and Windows. Finally, a compatibility layer has been
+added for iplib, ipapi and Shell. The follow things still need to be done::
+
+* I need to modify iptests to properly skip modules that are no longer top
+  level modules.
 
-Need to update the top level IPython/__init__.py file.
+* I Need to update the top level IPython/__init__.py file.  We need to make   
+  sure that as we change how this is setup, that all modules still import.
 
-Need to get installation working correctly.
+* When running python setup.py sdist, the Sphinx API docs fail to build
+  because of something going on with IPython.core.fakemodule
 
-When running python setup.py sdist, the Sphinx API docs fail to build because
-of something going on with IPython.core.fakemodule
+* :file:`Extensions`. This needs to be gone through separately.  Minimally,
+  the package should be renamed to :file:`extensions` and the PYTHONPATH
+  setting in __init__.py needs to be updated.
 
-Where things will be moved
-==========================
+Where things have been moved
+============================
 
 Top-level modules:
 
 * :file:`background_jobs.py`.  Move to :file:`IPython/lib/backgroundjobs.py`.
 
 * :file:`ColorANSI.py`.  Move to :file:`IPython/utils/coloransi.py`.
 
 * :file:`completer.py`.  Move to :file:`IPython/core/completer.py`.
 
 * :file:`ConfigLoader.py`.  Move to :file:`IPython/config/configloader.py`.
 
 * :file:`CrashHandler.py`.  Move to :file:`IPython/core/crashhandler`.
 
 * :file:`Debugger.py`.  Move to :file:`IPython/core/debugger.py`.
 
 * :file:`deep_reload.py`.  Move to :file:`IPython/lib/deepreload.py`.
 
 * :file:`demo.py`.  Move to :file:`IPython/lib/demo.py`.
 
 * :file:`DPyGetOpt.py`.  Move to :mod:`IPython.utils` and replace with newer options parser.
 
 * :file:`dtutils.py`.  Move to :file:`IPython.deathrow`.
 
 * :file:`excolors.py`.  Move to :file:`IPython.core` or :file:`IPython.config`.
   Maybe move to :mod:`IPython.lib` or :mod:`IPython.python`?
 
 * :file:`FakeModule.py`.  Move to :file:`IPython/core/fakemodule.py`.
 
 * :file:`generics.py`.  Move to :file:`IPython.python`.
 
 * :file:`genutils.py`.  Move to :file:`IPython.utils`.
 
 * :file:`Gnuplot2.py`.  Move to :file:`IPython.sandbox`.
 
 * :file:`GnuplotInteractive.py`.  Move to :file:`IPython.sandbox`.
 
 * :file:`GnuplotRuntime.py`.  Move to :file:`IPython.sandbox`.
 
 * :file:`numutils.py`.  Move to :file:`IPython.sandbox`.
 
 * :file:`twshell.py`.  Move to :file:`IPython.sandbox`.
 
-* :file:`Extensions`. This needs to be gone through separately.  Minimally,
-  the package should be renamed to :file:`extensions`.
-
 * :file:`history.py`.  Move to :file:`IPython.core`.
 
 * :file:`hooks.py`.  Move to :file:`IPython.core`.
 
 * :file:`ipapi.py`.  Move to :file:`IPython.core`.
 
 * :file:`iplib.py`.  Move to :file:`IPython.core`.
 
 * :file:`ipmaker.py`:  Move to :file:`IPython.core`.
 
 * :file:`ipstruct.py`.  Move to :file:`IPython.python`.
 
-* :file:`irunner.py`.  Move to :file:`IPython.scripts`. ???
+* :file:`irunner.py`.  Move to :file:`IPython.scripts`.
 
 * :file:`Itpl.py`. Move to :file:`deathrow/Itpl.py`. Copy already in
   :file:`IPython.external`.
 
 * :file:`Logger.py`.  Move to :file:`IPython/core/logger.py`.
 
 * :file:`macro.py`.  Move to :file:`IPython.core`.
 
 * :file:`Magic.py`.  Move to :file:`IPython/core/magic.py`.
 
 * :file:`OInspect.py`.  Move to :file:`IPython/core/oinspect.py`.
 
 * :file:`OutputTrap.py`.  Move to :file:`IPython/core/outputtrap.py`.
 
 * :file:`platutils.py`.  Move to :file:`IPython.python`.
 
 * :file:`platutils_dummy.py`.  Move to :file:`IPython.python`.
 
 * :file:`platutils_posix.py`.  Move to :file:`IPython.python`.
 
 * :file:`platutils_win32.py`.  Move to :file:`IPython.python`.
 
 * :file:`prefilter.py`:  Move to :file:`IPython.core`.
 
 * :file:`Prompts.py`.  Move to :file:`IPython/core/prompts.py` or
   :file:`IPython/frontend/prompts.py`.
 
-* :file:`PyColorize.py`. Replace with pygments? If not, move to
-  :file:`IPython/core/pycolorize.py`. Maybe move to :mod:`IPython.lib` or
-  :mod:`IPython.python`?
+* :file:`PyColorize.py`. Move to :file:`IPython/utils/pycolorize.py`. Explore
+  replacing with pygments.
 
 * :file:`Release.py`.  Move to ??? or remove?
 
 * :file:`rlineimpl.py`.  Move to :file:`IPython.core`.
 
 * :file:`shadowns.py`.  Move to :file:`IPython.core`.
 
 * :file:`Shell.py`.  Move to :file:`IPython.core.shell.py` or
   :file:`IPython/frontend/shell.py`.
 
 * :file:`shellglobals.py`.  Move to :file:`IPython.core`.
 
 * :file:`strdispatch.py`.  Move to :file:`IPython.python`.
 
 * :file:`twshell.py`.  Move to :file:`IPython.sandbox`.
 
 * :file:`ultraTB.py`.  Move to :file:`IPython/core/ultratb.py`.
 
 * :file:`upgrade_dir.py`.  Move to :file:`IPython/utils/upgradedir.py`.
 
 * :file:`usage.py`.  Move to :file:`IPython.core`.
 
 * :file:`wildcard.py`.  Move to :file:`IPython.utils`.
 
 * :file:`winconsole.py`.  Move to :file:`IPython.utils`.
 
 Top-level sub-packages:
 
 * :file:`testing`.  Good where it is.
 
 * :file:`tests`.  Remove.
 
 * :file:`tools`.  Things in here need to be looked at and moved elsewhere like
     :file:`IPython.utils`.
 
 * :file:`UserConfig`.  Move to :file:`IPython.config.userconfig`.
 
 * :file:`config`.  Good where it is!
 
 * :file:`external`.  Good where it is!
 
 * :file:`frontend`.  Good where it is!
 
 * :file:`gui`.  Eventually this should be moved to a subdir of   
   :file:`IPython.frontend`.
 
 * :file:`kernel`.  Good where it is.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Other things
 ============
 
 When these files are moved around, a number of other things will happen at the same time:
 
 1. Test files will be created for each module in IPython. Minimally, all
    modules will be imported as a part of the test. This will serve as a 
    test of the module reorganization. These tests will be put into new
    :file:`tests` subdirectories that each package will have.
 
 2. PyFlakes and other code checkers will be run to look for problems.
 
 3. Modules will be renamed to comply with PEP 8 naming conventions:  all
    lowercase and no special characters like ``-`` or ``_``.
 
 4. Existing tests will be moved to the appropriate :file:`tests`
    subdirectories.