Skip to main content

ZCML slug generation to be used separately e.g for repoze based setups

Project description


zc.buildout recipe to create zcml slugs. Useful for example in a repoze based buildout.

Change history

0.1 (2008-07-04)

  • Created recipe with ZopeSkel [Stefan Eletzhofer].

Detailed Documentation

Supported options

The recipe supports the following options:


A list of zcml entires.


zcml := package ":" filename
package := dottedname | dottedname "-" ( "configure" | "meta" | "overrides" )
The location of the zope 2 installation.

The guts of creating ZCML slugs was ripped from plone.recipe.zope2install.

Example usage

We’ll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = test1
... [test1]
... recipe = collective.recipe.zcml
... zope2-location=${buildout:directory}/zope
... zcml =
...     my.package
...     somefile:my.otherpackage
...     my.thirdpackage-meta
... """)

Running the buildout gives us:

>>> print 'start', system(buildout) # doctest:+ELLIPSIS
start Installing test1.
  Installing test1.
An internal error occured due to a bug in either zc.buildout or in a
recipe being used:
[Errno 2] No such file or directory: '/sample-buildout/zope/etc/package-includes'

We need to have a valid zope installation. Let’s fake one:

>>> mkdir("zope")
>>> mkdir("zope", "etc")
>>> print 'start', system(buildout) # doctest:+ELLIPSIS
start Installing test1.

We now have a package include directory:

>>> ls("zope", "etc")
d  package-includes

It does contain ZCML slugs:

>>> ls("zope", "etc", "package-includes")
-  001-my.package-configure.zcml
-  002-somefile-configure.zcml
-  003-my.thirdpackage-meta.zcml

These files contain the usual stuff:

>>> cat("zope", "etc", "package-includes", "001-my.package-configure.zcml")
<include package="my.package" file="configure.zcml" />
>>> cat("zope", "etc", "package-includes", "002-somefile-configure.zcml")
<include package="somefile" file="my.otherpackage" />
>>> cat("zope", "etc", "package-includes", "003-my.thirdpackage-meta.zcml")
<include package="my.thirdpackage" file="meta.zcml" />

That’s all.


Stefan Eletzhofer, Author


Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for collective.recipe.zcml, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size collective.recipe.zcml-0.1-py2.4.egg (9.8 kB) File type Egg Python version 2.4 Upload date Hashes View
Filename, size collective.recipe.zcml-0.1.tar.gz (5.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page