Metadata-Version: 1.1
Name: z3c.appconfig
Version: 1.0
Summary: Simple application configuration system
Home-page: http://svn.plone.org/svn/collective/
Author: Wichert Akkerman
Author-email: wichert@wiggy.net
License: BSD
Description: Introduction
        ============
        
        This package provides a method to configure an application via standard
        ``.ini`` files. This is convenient for site admins since they are more
        likely to be familiar with ini files than with ZCML.
        
        
        Creating config files
        =====================
        There are two ways to tell a Zope instance which configuration files to
        load: zcml statements and the APPCONFIG environment variable. zcml statements
        are processed first, making it possible to override standard configuration.
        
        The zcml syntax looks like this::
        
          <configure xmlns="http://namespaces.zope.org/zope">
            <include package="z3c.appconfig" file="meta.zcml"/>
            <appconfig file="default.ini" />
          </configure>
        
        This will load the contents of ``default.ini`` and merge it into the
        application configuration.
        
        If an APPCONFIG environment variable is set and points to a file
        its contents will be merged into the application configuration. This is done
        last, allowing you to override application defined defaults. For example::
        
           $ APPCONFIG=etc/mysite.ini bin/instance fg
        
        
        Accessing configuration
        =======================
        
        The configuration data can be accessed from your code via a IAppConfig utility.
        This utility is essentially a standard python dictionary which stores all
        configuration data. For example lets use a very simple configuration file::
        
           [site]
           title = My lovely site
        
        You can access the title from python with code like this::
        
           from zope.component import getUtility
           from z3c.appconfig.interfaces import IAppConfig
        
           appconfig=getUtility(IAppConfig)
           print "Site title is: %s" % appconfig["site"]["title"]
        
        
        Utility methods
        ===============
        
        As a convenience a utility method is provided to convert values from a
        configuration file to booleans: the ``z3c.appconfig.utils.asBool`` method::
        
           from z3c.appconfig.utils import asBool
           print "Pants are on: %s" % asBool("true")
        
        
        
        Changelog
        =========
        
        1.0 (2011-01-24)
        ----------------
        
        - Add more trove classifiers.
          [wichert]
        
        - Add a ``asBool`` utility method.
          [wichert]
        
        
        
        1.0b1 (2010-05-17)
        ------------------
        
        - Initial release.
          [wichert]
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Plone
Classifier: Framework :: Zope2
Classifier: Framework :: Zope3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Software Development :: Libraries :: Python Modules
