Home       Trees       Index       Help   

"Lemon"

Package lemon :: Package external :: Package Cheetah
[show private | hide private]
[frames | no frames]

Package lemon.external.Cheetah

Cheetah is a Python-powered template engine and code-generator.
It similar to the Jakarta project's Velocity.

Homepage
================================================================================
http://www.CheetahTemplate.org

Mailing list
================================================================================
cheetahtemplate-discuss@lists.sourceforge.net
Subscribe at
http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss

Documentation
================================================================================

For a high-level introduction to Cheetah please refer to the User's Guide
in the docs/ directory of the Cheetah distribution.

Installation
================================================================================
Cheetah can be run a directory in the from the system-wide Python path or
from a directory in a user's Python path.  

To install Cheetah for a single user:
  - copy the 'src' sub-directory to a directory called 'Cheetah' that is in the
  user's PYTHON_PATH

To install Cheetah for system-wide use:
  - on Posix systems (AIX, Solaris, Linux, IRIX, etc.) become the 'root' user
  and run: python ./setup.py install
  
  - On non-posix systems, such as Windows NT, login as an administrator and
  type this at the command-line:  python setup.py install

On Posix systems, the system-wide installation will also install the Cheetah's
command-line compiler program, TScompile, to a system-wide executable path such as
/usr/local/bin.
 

Meta-Data
================================================================================
Authors: The Cheetah Development Team (Tavis Rudd, Mike Orr, Chuck Esterbrook
         Ian Bicking, Tom Schwaller)
License: This software is released for unlimited distribution under the
         terms of the Python license.
Version: $Revision: 1.1 $
Start Date: 2001/03/30
Last Revision Date: $Date: 2003/08/12 09:17:11 $
Submodules
  • CheetahWrapper: Cheetah command-line interface.
  • Compiler: Compiler classes for Cheetah: ModuleCompiler aka 'Compiler' ClassCompiler MethodCompiler If you are trying to grok this code start with ModuleCompiler.__init__, ModuleCompiler.compile, and ModuleCompiler.__getattr__.
  • DummyTransaction: Provides dummy Transaction and Response classes is used by Cheetah in place of real Webware transactions when the Template obj is not used directly as a Webware servlet.
  • ErrorCatchers: ErrorCatcher class for Cheetah Templates...
  • FileUtils: File utitilies for Python: Meta-Data ================================================================================ Author: Tavis Rudd <tavis@damnsimple.com> License: This software is released for unlimited distribution under the terms of the Python license.
  • Filters: Filters for the #filter directive; output filters Cheetah's $placeholders .
  • ImportHooks: Provides some import hooks to allow Cheetah's .tmpl files to be imported directly like Python .py modules.
  • ImportManager: Provides an emulator/replacement for Python's standard import system.
  • Lexer: Lexer base-class for Cheetah's Parser...
  • NameMapper: This module implements Cheetah's optional NameMapper syntax.
  • Parser: Parser classes for Cheetah's Compiler...
  • Servlet: Provides an abstract Servlet baseclass for Cheetah's Template class Meta-Data ================================================================================ Author: Tavis Rudd <tavis@damnsimple.com> License: This software is released for unlimited distribution under the terms of the Python license.
  • SettingsManager: Provides a mixin/base class for collecting and managing application settings...
  • SourceReader: SourceReader class for Cheetah's Parser and CodeGenerator Meta-Data ================================================================================ Author: Tavis Rudd <tavis@damnsimple.com> License: This software is released for unlimited distribution under the terms of the Python license.
  • Template: Provides the core Template class for Cheetah See the docstring in __init__.py and the User's Guide for more information Meta-Data ================================================================================ Author: Tavis Rudd <tavis@damnsimple.com> License: This software is released for unlimited distribution under the terms of the Python license.
  • TemplateCmdLineIface: Provides a command line interface to compiled Cheetah template modules.
  • Templates
    • SkeletonPage: A Skeleton HTML page template, that provides basic structure and utility methods.
    • _SkeletonPage: A baseclass for the SkeletonPage template...
  • Tests
    • CheetahWrapper: Tests for the 'cheetah' command.
    • FileRefresh: Tests to make sure that the file-update-monitoring code is working properly THIS TEST MODULE IS JUST A SHELL AT THE MOMENT.
    • NameMapper: NameMapper Tests...
    • SyntaxAndOutput: Syntax and Output tests.
    • Template: Tests of the Template class API THIS TEST MODULE IS JUST A SHELL AT THE MOMENT.
    • Test: Core module of Cheetah's Unit-testing framework TODO ================================================================================ # combo tests # negative test cases for expected exceptions # black-box vs clear-box testing # do some tests that run the Template for long enough to check that the refresh code works Meta-Data ================================================================================ Author: Tavis Rudd <tavis@damnsimple.com>, License: This software is released for unlimited distribution under the terms of the Python license.
    • unittest_local_copy: This is a hacked version of PyUnit that extends its reporting capabilities with optional meta data on the test cases.
  • Tools: This package contains classes, functions, objects and packages contributed by Cheetah users.
    • CGITemplate: A subclass of Cheetah.Template for use in CGI scripts.
    • MondoReport: MondoReport.py -- Batching module for Python and Cheetah.
    • RecursiveNull: Nothing, but in a friendly way.
    • SiteHierarchy: Create menus and crumbs from a site hierarchy.
  • Utils
    • Indenter: Indentation maker.
    • Misc: Miscellaneous functions/objects used by Cheetah but also useful standalone.
    • optik: optik A powerful, extensible, and easy-to-use command-line parser for Python.
      • errors: optik.errors Exception classes used by Optik.
      • option: optik.option Defines the Option class and some standard value-checking functions.
      • option_parser: optik.option_parser Provides the OptionParser and Values classes.
    • VerifyType: Functions to verify an argument's type Meta-Data ================================================================================ Author: Mike Orr <iron@mso.oz.net> License: This software is released for unlimited distribution under the terms of the Python license.
    • WebInputMixin: Mixin for Cheetah.Servlet for importing web transaction variables in bulk.
  • Version
  • _properties

Variable Summary
str __author__ = 'Tavis Rudd <tavis@damnsimple.com>'
str __revision__ = '1.1'

Variable Details

__author__

Type:
str
Value:
'Tavis Rudd <tavis@damnsimple.com>'

__revision__

Type:
str
Value:
'1.1'

   Home       Trees       Index       Help   

"Lemon"

Generated by Epydoc 2.0 on Mon Nov 10 15:07:58 2003 http://epydoc.sf.net