Edit me on GitHub

pyramid_zcml

Overview

pyramid_zcml is a package which provides ZCML directives for all built-in Pyramid configurator methods.

Installation

Install using setuptools, e.g. (within a virtualenv):

$ easy_install pyramid_zcml

Setup

Once pyramid_zcml is installed, you must use the config.include mechanism to include it into your Pyramid project’s configuration. In your Pyramid project’s __init__.py:

1
2
3
4
import pyramid_zcml

config = Configurator(.....)
config.include(pyramid_zcml)

Do this before trying to load any ZCML. After this step is taken, it will be possible to use the pyramid_zcml.load_zcml() function as a method of the configurator, ala:

1
config.load_zcml(....)

Paster Template

The pyramid_starter_zcml Paster template is included with this package. You can use it via paster create -t pyramid_starter_zcml (on Pyramid 1.0, 1.1, or 1.2) or pcreate -s pyramid_starter_zcml (on Pyramid 1.3). It creates a package skeleton which configures a Pyramid appliction via ZCML. The application performs URL mapping via traversal and no persistence mechanism.

Reporting Bugs / Development Versions

Visit http://github.com/Pylons/pyramid_zcml to download development or tagged versions.

Visit http://github.com/Pylons/pyramid_zcml/issues to report bugs.