root / pycommunity / pycommunity / doc / configuration.txt

=============
configuration
=============
$Id:$

`configuration` provides a class to read config files::

    >>> from configuration import Configuration
    >>> config = Configuration('tests/pycommunity.conf')

packages, recipes, and tutorials folders can be read with 
direct methods::
    
    >>> config.recipes
    {'recipes': 'tests/svn/project/recipes'}
    >>> tuts = config.tutorials.items()
    >>> tuts.sort()
    >>> tuts
    [('tuts', 'tests/svn/project/tutorials')] 
    >>> config.glossary
    '/etc/pycommunity/glossary.txt'
    >>> packages = config.packages.items()
    >>> packages.sort()
    >>> packages
    [('package1', 'tests/svn/project/src/package1')] 
    >>> config.targets
    {'target1': 'tests/www'}
    >>> templates = config.templates.items()
    >>> templates.sort()
    >>> templates
    [('css', 'tests/templates/pycommunity.css'), 
     ('glossary', 'tests/templates/glossary.pt'), 
     ('index', 'tests/templates/index.pt'), 
     ('js', 'tests/templates/pycommunity.js'),
     ('packagedoc', 'tests/templates/packagedoc.pt'), 
     ('packageindex', 'tests/templates/packageindex.pt'), 
     ('packagesindex', 'tests/templates/packagesindex.pt'), 
     ('packagestats', 'tests/templates/packagestats.pt'), 
     ('recipe', 'tests/templates/recipe.pt'), 
     ('recipelist', 'tests/templates/recipelist.pt'), 
     ('tutorial', 'tests/templates/tutorial.pt'), 
     ('tutoriallist', 'tests/templates/tutoriallist.pt')]    
    >>> config.media
    'tests/templates/media'
    >>> 'projectname' in config.options
    True