Package amplee :: Module loader
[show private | hide private]
[frames | no frames]

Module amplee.loader

Atom Publising Store loader

Synopsis
--------

The process of creating an Atom Publishing store is
a repetitive task that is common to all projects.

The loader module offers the possibility to automate
this task by putting required information in a
configuration file and let the `loader`function
generates the store from the configuration settings.

Consider the following:

>>> from amplee.loader import loader
>>> service, config = loader('/my/config.cfg')

The ``service`` object returned is an instance of
``amplee.atompub.service.AtomPubService`` and is your
reference to all the related objects.

The ``config`` object is an instance of
``amplee.loader.Config`` and is the representation
of your configuration file.

Classes
Config Represents an INI file as a tree of Config instances

Function Summary
  loader(conf_path, encoding, base_path)
Creates the structure of an APP store following settings provided by the configuration file.

Function Details

loader(conf_path, encoding='ISO-8859-1', base_path=None)

Creates the structure of an APP store following settings
provided by the configuration file. It returns the created
service instance as well as the configuration instance.

The ``conf_path`` is the path to the configuration settings
The ``encoding`` indicates how to encode each value of the settings
The ``base_path``, if provided, will be prepended to all the
  values which require a path

Generated by Epydoc 2.1 on Thu Jul 19 15:32:17 2007 http://epydoc.sf.net