[PyCrust-cvs] PyCrust PyCrust.txt,NONE,1.1

[<po...@us...>]

Update of /cvsroot/pycrust/PyCrust
In directory sc8-pr-cvs1:/tmp/cvs-serv7131

Added Files:
	PyCrust.txt 
Log Message:
New doc


--- NEW FILE: PyCrust.txt ---
=========
 PyCrust
=========

---------------------------
 The Flakiest Python Shell
---------------------------

:Author: Patrick K. O'Brien
:Contact: po...@or...
:Date: $Date: 2003/03/24 14:58:14 $
:Revision: $Revision: 1.1 $

.. contents::


Introduction
============

This document will show you how to make use of PyCrust.


What is PyCrust?
================

PyCrust is really several things.  First, PyCrust is a standalone
application that provides a graphical, Python shell interface.
Second, PyCrust is a collections of modules that you can use in your
own wxPython applications to provide similar services, either for your
own use during development, or as an interface for users of your
program.  Third, PyCrust is a wrapper utility, providing you with
runtime introspection capabilities for your wxPython programs without
having to include PyCrust in your program or alter one line of code.


PyCrust standalone
==================

There are actually three standalone applications in the PyCrust
package:

* PyCrustApp
* PyShellApp
* PyFillingApp


PyCrust modules
===============

PyCrust was designed to be modular.  That means graphical code is kept
separate from non-graphical code, and many of the PyCrust modules can
be used by other programs.  Likewise, other programs can supply some
of the modules needed by PyCrust.  For example, you could supply a
customized interpreter module and plug it in to the PyCrust standalone
application.  As long as it supports the minimum functionality
required, PyCrust will work just as well with your interpreter as with
its default interpreter.


PyCrust runtime wrapper
=======================

The PyCrust wrapper utility (``wrap.py``) lets you run an existing
wxPython program with a PyCrust frame at the same time.  Inside the
PyCrust shell, the local variable ``app`` is assigned to your
application instance.  In this way you can introspect your entire
application within the PyCrust shell and the PyCrust namespace
viewer.  And through the use of the PyCrust decorator classes, PyCrust
can display wxPython function and method signatures as well as
docstrings for the entire wxPython library.