Eggification of Zope Packages

Problem

Many zope.* packages are already eggified before this proposal. There are some packages remaining. This proposal is to track eggification of packages under zope and zope.app namespace which are distributed with Zope 3.

This proposal also track zc.buildout support for zope.* packages.

Proposal

The packages to be eggified are given below with status information. All packages will be having a unique version, that is 3.4 when released, and 3.4dev during development. Already eggified packages can be used as reference for further eggification.

Current status of packages

The package dependencies have changed. The zope.app package is deprecated, all packages that are not listed here, are not checked if they use the deprecated zope.app package.

Note that we also have to eggify deprecated packages, which have to be there for the 3.4 release, so that 3.4 packages are backward compatible.

Implementation Details

Replace packagename with respective package names below.

• Packages should be committed to svn://svn.zope.org/repos/main/zope.packagename/trunk

• Also there should be these directories:

  - svn://svn.zope.org/repos/main/zope.packagename/branches
  - svn://svn.zope.org/repos/main/zope.packagename/tags
  

• A typical top directory will have these files:

  bootstrap.py
  buildout.cfg
  README.txt
  setup.py
  setup.cfg
  src/
  

• Under src, create a zope directory with an __init__.py with this content:

  # namespace package boilerplate
  try:
      __import__('pkg_resources').declare_namespace(__name__)
  except ImportError, e:
      from pkgutil import extend_path
      __path__ = extend_path(__path__, __name__)
  

• Set svn:ignore property of top directory like this:

  bin
  build
  develop-eggs
  dist
  eggs
  lib
  parts
  .installed.cfg
  

• Set svn:ignore property of src directory like this:

  zope.packagename.egg-info
  

• Set svn:externals property in src/zope (or src/zope/app) to include a line like this:

  packagename svn://svn.zope.org/repos/main/Zope3/trunk/src/zope/packagename
  

• If any other packages are required to compile the current package, create an include package under main directory, and set svn:externals property to the package required. Look at zope.security package for more info. This is needed to pick up the C headers from the other package; the finished egg will not include the code from such packages.

Risks

None identified.

Implementation status

All necessary packages are eggified and buildout support has been added.

Comments

... --seletz, Thu, 26 Oct 2006 12:11:28 -0700 reply

Please color-code the tables. Red/Green sort of color codes ;)