ape.plugins.apeplugin.Ape

class ape.plugins.apeplugin.Ape(configfiles=None, *args, **kwargs)

The default plugin (provides the front-end for the APE)

Ape plugin Constructor

Param:

• configfiles: list of config-files to build product (Hortator Composite)

__init__(configfiles=None, *args, **kwargs)

Ape plugin Constructor

Param:

• configfiles: list of config-files to build product (Hortator Composite)

Methods

__init__([configfiles])	Ape plugin Constructor
fetch_config()	Prints example configuration to stdout
help([width])	Prints a help-string for the plugin
log_error(error[, message])	Logs the error in bold red

Attributes

arguments	The ArgumentBuilder (used to set up the help-string)
help_page	A HelpPage to use if self.sections has been defined
logger	return:A logging object.
product	This is the Hortator Composite product
Ape.quartermaster
sections	An ordered dictionary for the HelpPage

fetch_config()

Prints example configuration to stdout

help(width=80)

Prints a help-string for the plugin

Param:

• width: number of characters wide to print help

log_error(error, message='')

Logs the error in bold red

Param:

• error: error type (prefix in red and bold)
• message: descriptive message (red but not bold)

arguments

The ArgumentBuilder (used to set up the help-string)

help_page

A HelpPage to use if self.sections has been defined

logger

Returns:A logging object.

product

This is the Hortator Composite product

Precondition:self.configfiles has been set Returns:hortator built from self.configfiles

sections

An ordered dictionary for the HelpPage