Package console

Overview

The console framework allows for the rapid development of interactive console based applications in Python in the style of the Python shell. Software developers often want to create lightweight programs using the terminal or the shell to control minor or partial functionality in a large application. Instead of writing a completly scripted executable .py file, the console framework allows for the rapid integration of specific commands into a customizable interactive shell.

At its most basic, the framework allows you to create InteractiveCommands to be added to an InteractiveShell. These commands have name, description, and help text associated with them, and allow you to add specific functionality, which returns output via stdout. InteractiveShell allows you to customize a banner and a prompt, and can be easily created and instantiated with commands in a __main__ method.

Tutorial

See interactive for specifics about extending InteractiveCommand and instantiating and running InteractiveShell. See example for a working example of a console program.

Package Organization

The console source code contains the following subpackages and modules:

Package Tree for console

interactive is the entry point to the console framework. This module allows you to create InteractiveCommands and an CustomCompleter to be added to an InteractiveShell.

example contains a sample program for reference.

Author: Peter Eacmen

Organization: Tactical Network Solutions

License: Open Source MIT License

Copyright: © 2010 Tactical Network Solutions

Requires: Python 2.6

Version: 1.0

Change Log: init.py 2 2010-11-29 13:48:00 -0400 bbengfort

Since: 2010-11-29 17:20:39 -0400

See Also: * Tactical Network Solutions

To Do: * Create console Wiki page * Create consoel Google Code Project * Create documentation config file * Create examples * Create console-program examples * Create customized icon * Re-add colorization * Add ASCII tables