Zope 3 Package Guide

Packages from the zope.* namespace

zope.annotation

allow attaching data to objects. Offers an implementation which stores this data in a special attribute of the objects

zope.browser

contains a few interfaces used in other packages

zope.cachedescriptors

allows memoizing attributes

zope.component

implements ZCA. Offers adapters, utilities, subscribers, handlers. In implementation are used registers in which components are registered, ofering also the posibility to create local registries, that will have priority before the global registries (using the sites mechanism)

zope.configuration

defines an extensible configuration system. Implements the bases of ZCML

zope.contentprovider

provides the posibility to componentize the page structure with dynamic pieces of content, which can be reused and connected to the type of context, request and page unto which they are inserted

zope.contenttype

utilities to determine the type of files, extends the mimetypes standard module

zope.copypastemove

support for copy, paste and move operations for objects. Generates events when those operations are executed

zope.datetime

definitions and utilities to manipulate time and date objects

zope.deferredimport

support for optimizing python import operations, which helps in faster loading of applications

zope.deprecation

defines and API useful in marking modules or functions as deprecated

zope.documenttemplate

a templating engine for the DTML syntax

zope.dottedname

allows solving Python objects using dotted names

zope.dublinecore

general implementation of DublinCore?, offers an implementation that stores that data in annotation

zope.error

global implementation of local and global utilities for error reporting

zope.event

implements a notification system using a subscribers system that defines handlers for those events

zope.exception

contains definitions for basic exceptions and utilities to format exceptions

zope.filereprezentation

defines interfaces used in representing objects through various protocols, such as WebDav? or FTP

zope.formlib

a general form library that will generate, validate and automatically process web forms

zope.hookable

makes it possible to have global, explicit, monkey-patching at runtime

zope.i18n

base implementation of internationalization in zope, implements translation domains, message catalogs, a zcml extension to register message catalogs and has utilities for internationalization of messages such as money, dates, numbers, etc.

zope.i18nmessage

implements internationalizable messages

zope.index

implements indexes as BTree? structures, optimized to index several types of data: fields with values, text and list of values. These indexes are used in the implementation of the catalog

zope.interface

the base library in Zope 3, allows defining, using and querying objects and the interfaces that they provide. Represents one of the important pieces in ZCA

zope.lifecycleevent

defines a series of events that an object can be involved (creating, erasing, changing, adding in a container)

zope.location

defines a method of physically locating objects by using their name and their parent, also has utilities to locate them. Defines utilities to place objects in a particular location in the objects tree by proxying them with LocationProxy?. This proxy is very important as it allows publishing non-persistent objects through the web, and also allows creating URL patterns that don't match the physical structure of the database

zope.minmax

defines a method of solving conflicts from the MVCC infrastructure using values that come from a policy that favors minimal or maximal values of objects involved in the conflict

zope.pagetemplate

implements pages that use template with TAL syntax implementeaza pagini ce folosesc template-uri cu sintaxa TAL

zope.proxy

a C based implementation of proxies. Is used by the other libraries to implement location and security proxies

zope.publisher

implements publishing mechanisms for content through http, ftp and xmlrpc protocols, defines the involved components (request, response, skins, internationalization, etc) and has WSGI support for them

zope.rdb

integrates with relational databases by creating and maintaing global connections with them

zope.schema

extends zope.interface to implement specific types of attributes (for example, numbers, lines of text, list of values, etc). Here are defined the vocabularies - utilities that return a list of values to display options in user interfaces. One of the base packages for Zope when it comes to implementing user interfaces

zope.security

defines a security system tha uses principals and permission to restrict access to objects and their attributes. Contains integration with ZCML for permission definitions and security policies

zope.securitypolicy

defines Zope's security policy, which extends the security infrastructure with roles and group, to achieve a greater flexibility. Defines the way roles and permissions are stored on objects using maps and security managers. Contains integration with ZCML for role definitions and granting permissions to roles and principals.

zope.sendmail

defines global utilities that can be used to send emails (synchronous, queued) and has zcml integration to define them

zope.sequencesort

utilities to sort lists

zope.server

contains an implementation for ftp and http servers. ZServer? (this implementation) is one of the fastest Python HTTP servers

zope.session

implements session and utilities to identify clients

zope.size

defines the way size information is extracted from objects, contains a basic implementation of this

zope.structuredtext

an engine to change Structured Text into HTML

zope.tal

an implementation of TAL templating syntax

zope.tales

contains TAL extensions to introduce new types of expresions to traverse objects

zope.testbrowser

contains an http browser that can be programmed, useful in defining functional texts

zope.testing

contains utilities that can be used in defining tests for Zope application and packages. Contains support for unit tests and integration tests

zope.testrecorder

contains a web proxy that can be used in recording the http communication, useful in writing integration tests

zope.thread

defiens a way to create and manage per thread local objects. This is a simple extension of the thread standard module

zope.traversing

defines utilities and traversing namespaces, also has utilities to compute absolute URLs? for objects, taking into consideratio the application's virtual hosting

zope.viewlet

extends the concept of content provider with that of viewlet and viewlet managers, to allow defining an area where viewlets can be inserted, which are dependent on the context type and the area where they are inserted. Defines, also, several standard viewlet managers

zope.xmlpickle

pickle based serialization to and from xml

Packages from the zope.app namespace

zope.app.apidoc

makes it possible to introspect objects with an autogenerated page that presents the provided interfaces, attributes and documentation. Offers a ZCML extension to register documentation for the so-called "Zope Book"

zope.app.aplicationcontrol

Offers the possibility to control the application by the user (stop/restart/ database pack, etc)

zope.app.appsetup

a way to configure and build Zope applications

zope.app.authentication

a complex system, based on plugins, to extract authentication data and to authenticate users (including the source of users)

zope.app.basicskin

a simple skeleton skin

zope.app.boston

a complete skin, similar to Rotterdam, based on viewlets

zope.app.broken

integrates broken objects from the database so that they can be viewed and debugged

zope.app.cache

a global utility that can store data for caching purposes

zope.app.catalog

a complete indexing and searching solution for objects. Has two types of indexes, based on zope.index: text and field

zope.app.component

Extensions of zope.component. Integrates the various Zope components (views, layers, security, utilities, etc) and defines zcml extensions for them.

zope.app.container

A BTree? based implementation of containers, defines how they are traversed and also has support for preconditions (what types of objects can be added, etc)

zope.app.content

Defines the IContentType? interface, which can be used to mark other interfaces as having that type. Defines a vocabulary that lists these interfaces.

zope.app.dav

Has a webdav server integrated with the rest of Zope infrastructure, has integration with ZCML

zope.app.debug

has a debugger that can be started from the application controller script

zope.app.dependent

provides a method to mark objects in the graph as being dependent on each other

zope.app.dtmlpage

has a content type based on DTML templates

zope.app.exception

pages for exceptions, generating the equivalent in HTTP exceptions

zope.app.external

minimal integration for what is needed to build an external editor

zope.app.file

two new types of content: File and Image, also with integration for their external representation (IFileRepresentation?)

zope.app.folder

offers a folder content type, integrated with the management interface and its representation as external object (IFileRepresentation?)

zope.app.form

the old form library for Zope, it is considered outdated because of the dependency on ZCML and inflexibility. All these considered, the widget model is also used by zope.formlib and thus remains an important library

zope.app.ftp

a view model for FTP

zope.app.generations

migrationi for database when the persistent objects schema is changed

zope.app.homefolder

has a homefolder implementation for users

zope.app.http

integration with the http protocol: exceptions, methods, traversing methods and how views are solved

zope.app.i18n

implements a persistent i18n messages catalog and ZCML extensions to register translation folders

zope.app.i18nfile

internationalizable images and files (as content)

zope.app.interface

a vocabulary for interfaces that an object provides

zope.app.interpretor

an untrusted Python code interpretor

zope.app.intid

a utility that associates unique ids to objects from the database

zope.app.keyreference

an adapter for persistent objects that extracts their low level id from the database, based on which an intid can be associated

zope.app.locales

contains translation and utilities for Zope 3 software

zope.app.locking

an implementation for object access locking, to be used, for example, in WebDav?

zope.app.module

persistent Python modules (Python code in ZODB)

zope.app.onlinehelp

an infrastructure for help and documentation and a ZCML extension that makes it possible to register help by any extension package

zope.app.pagetemplate

integrates ZPT templates with the view classes, offers a ZCML expression that makes it possible to register new types of ZPT expressions

zope.app.preference

implements a method of storing preferences for each user and contains integration with ZCML for recording groups of preferences

zope.app.preview

a simple way of previewing the site in an iframe

zope.app.principalannotation

a method to associated data with principals, through a persistent annotation

zope.app.publication

integrated methods of content publishing, has a ZCML extension to define new methods of publishing, for each HTTP verb used

zope.app.publisher

implements objects/pages that can be used in publishing content. Implements ZCML extensions to register pages and menus in ZCML

zope.app.pythonpage

implements a type of persistent content that can interpret Python

zope.app.renderer

a library useful in transforming from one type of content into another one (for example, from rest or stx in html)

zope.app.rotterdam

the most used Zope skin, implements a complex management interface

zope.app.schema

integrates zope.schema with the security infrastructure, has a registry for vocabularies

zope.app.security

implements the security infrastructure of Zope, has base methods to authenticate users and generate principals, offers zcml extensions to declare global principals and groups

zope.app.securitypolicy

implements pages that can be used to make local changes (in the database) of the security settings

zope.app.server

implements http and wsgi servers, makes it possible to configure and to control them

zope.app.session

has support for session through association of data with a client

zope.app.sqlscript

implements content objects that can execute sql commands

zope.app.testing

has utilities to create tests

zope.app.tree

implements a tree widget that can be used in user interfaces to represent graph of objects

zope.app.twisted

implements a server based on Twisted with configuration and control

zope.app.undo

implements pages to control and execute undo steps

zope.app.winservice

an service integrated with WinNT? based operating systems

zope.app.workflow

a method of workflow and support for persistent definitions of workflows

zope.app.wsgi

a WSGI application, used in building WSGI based Zope applications

zope.app.xmlrpcintrospection

offers introspection for the XMLRPC module, by implementing a few new methods

zope.app.zapi

groups some of the most used functions, for the convenience of developers

zope.app.zcmlfiles

a few zcml files that group, by theme, the Zope packages, allowing selective loading

zope.app.zopeappgenerations

migrates the database from older versions of Zope

zope.app.zopetop

a Zope skin, not very popular as it is an older version

zope.app.zptpage

implements persistent templates in the database

General packages

Zem

The External Editor version targeted at Macs

Zelenium

Zope 2 product allows developers to create TTW Selenium test suites inside their Zope instance, in order to do browser-based functional testing of their site.

ZConfig

is a configuration library intended for general use. It is used in Zope 2 and Zope 3 to parse configuration files.

book

The code for the Zope 3 Book (by Stephen Richter)

bugtracker

A bugtracker implemented in Zope 3

cc.buildout_reports

cc.buildout_reports provides recipe[s]? for generating developer reports using zc.buildout.

cc.gettext

cc.gettext provides recipe[s]? for manipulating gettext message catalogs.

cxoracleda

A cx_Oracle based Database Adapter for Zope3

docutils

Readers, writers and parsers for various formats, including Restructured Text (general purpose library)

eventworkflow

Contains a prototype for workflow definitions, that solely uses Zope's event subscriptions as the workflow "engine". Meant as a prototype, proof of concept.

five.customerize

Provides the ability to locally customize Page Template-based browser views, much like it is possible to customize file-system based view templates in the CMF's portal_skin tools.

five.localsitemanager

Provides a local site manager based on the standard Zope 3 local site manager for Zope 2.

gocept.zope3instance

Buildout recipe to create a Zope 3 instance

gocept.bsquare

This package provides a buildout configuration and utilities to automatically monitor a subversion repository defining zc.buildout-based projects. It also defines an alternative comprehensive view (inspired by cruise control) accessiable via /cruise.

gocept.registration

This package provides functionality to implement user self-registration for applications.

jquery.demo

A Z3c Website demo helper package for the JQuery? features.

jquery.javascript

This package contains the JQuery? library. It also creates viewlets for the JAvascript? resources.

jquery.jsonform

JQuery? based JSON form validation

jquery.jsontree

The jsontree is a <ul> tag tree loading child items via JSON form a context.

jquery.layer

A browser skin layer that has the jQuery javascript library available as resources.

jquery.livesearch

JSON/jQuery based livesearch

jquery.widget

This package contains a collection of JQuery?-based widgets. Right now it has a REST editor, which renders a textarea and a toolbar to format the text using the REST syntax.

keas.kmi

This package provides a NIST SP 800-57 compliant Key Management Infrastructure (KMI).

keas.pbpersist

Provides a way to store ZODB objects using Google Protocol Buffer encoding rather than pickling. The Protocol Buffer format is more limited than pickles, but it is also simpler, better documented, and not dependent on any particular programming language.

keas.pbstate

Provides a way to store Python object state in a Google Protocol Buffer.

ldapadapter

The LDAPAdapter? provides a mechanism to connect to an LDAP server and send commands to it.

ldapauth

The ldapauth package is a plugable auth module for the "plugable authentication service" which supports authentication on LDAP. (old package which would probably need work to get it to work with latest Zope 3)

ldappas

This is a plugin for the pluggable authentication utility (located at zope.app.authentication) to deal with LDAP principal sources. It depends on the ldapadapter module (which itself depends on python-ldap).

mysqldba

A MySQL? database adapter for Zope 3

pdlib

A page design Javascript library - library for manipulating objects on a page with object selection, context menus, and drag and drop. Mostly DOM 2 oriented, with bits for IE compatibility.

photo

Utilities and helpers to have images with multiple sizes. The photoslide package comes with a container for photos and provides nice views for all photos.

psycopgda

Zope 3 PostgresSQL? database adapter

projectsupport

Project Support provides a set of scripts which help developers work with individual zope projects.

profilestats

Utilities to profile various operations in Zope 3

p01json

JSON-RPC client javascript library

p01jsonform

JSON based form validation

p01xmlhttp

An xmlhttp javascript library

relstorage

Alternate storage for ZODB, store pickles in an SQL database (PostgreSQL?, MySQL?, or Oracle).

s5-themes

Themes for the html export function of docutils

scheduler

A Zope task scheduler

soap

A SOAP implementation to provide SOAP views for objects.

web

Zope Foundation related documents (no code here)

Lovely Systems packages

Open source packages produced by Lovely Systems under the lovely namespace

lovely.buildouthttp

Extends the buildout to enable password protected package repositories

lovely.flickr

A Flickr API library

lovely.flickrconnector

Provides a Zope 3 utility to connect to Flickr using the lovely.flickr library

lovely.flvplayer

A flash video player for Zope 3

lovely.mail

This package mainly provides a simple way to test the mail delivery using the current configuration. There is no need to change the mailing configuration for the functional tests.

lovely.memcached

This package provides a zope3 utility that abstracts a client for memcached servers see: http://www.danga.com/memcached.

lovely.mount

A multi-zodb database support for Zope 3

lovely.persistent

A replacement for the Persistent class that only gets marked as changed when the its attributes are really changed.

lovely.rating

A rating system that can be plugged for any content type

lovely.recipe

A recipe that helps with creating files and folders in a buildout.

lovely.relation

This package provides functionality to realize relations using the zc.relationship package.

lovely.remoteinclude

This package allows to render include views of viewlets and views which implement the IContentProvider? interface. This is done by a subscriber on BeforeUpdateEvent?.

lovely.responsecache

This package allows to cache results of ContentProviders?. Note that normal zope BrowserViews? do not implement the IContentProvider? interface, so in order to cache views, they have to implement the update and render methods. For a base class see z3c.viewtemplate.baseview.BaseView?.

lovely.remotetask

This package provides an implementation of a remote task execution Web service that allows to execute pre-defined tasks on another server. It is also possible to run cron jobs at specific times.

lovely.skinbrowser

An APIDOC module that show pages and templates for skins and layers developed using z3c.viewtemplate

lovely.tag

A tagging engine implementation

lovely.viewcache

Facilitates caching of views; This package is superseded by lovely.responsecache.

lovely.zetup

Run Zope as a WSGI app with no ZODB, wired with Paste.

Grok packages

Packages to be used together with grok

grok

A project that is meant to provide an easy development environment for the Zope 3 platform, by providing "good defaults over configuration" and no need for ZCML files.

grokcore.component

This package provides base classes of basic component types for the Zope Component Architecture, as well as means for configuring and registering them directly in Python (without ZCML).

grokproject

Code skeleton generator for grok based projects.

grokapps

A collection of tutorial apps created with grok

megrok.cherry

An experimental integration of Zope 3 with the CherryPy? WSGI server.

megrok.feeds

Atom and RSS syndication feeds for Grok applications. (in work)

megrok.five

Provides integration of grok_ into Zope 2.

megrok.genshi

Makes it possible to use Genshi templates in Grok.

megrok.kss

Add KSS support to your grok app

megrok.quarry

MEGROK.QUARRY is an implementation of skins, layers and template re-use. Highly experimental.

megrok.menu

This package allows you to register browser menus and menu items for browser views in Grok.

megrok.trails

The Trails package allows you to define the URLs? your users travel in order to visit objects on your site, and also provides the means by which Grok can determine what the URL for a given object should be.

megrok.viewlet

A proof of concept of a way to support portlets in Grok.

martian

Martian provides infrastructure for declarative configuration of Python code. Martian is especially useful for the construction of frameworks that need to provide a flexible plugin infrastructure. (useful for Grok projects)

gzo.plonepolicy

Plone policy for the Plone section of the Grok website

gzo.plonesmashtheme

A Plone theme to be used in the Plone section of the Grok website.

Grokstar

A blogging application using grok. Still in alpha.

z3c Packages

The z3c (Zope 3 Community) namespace

z3c.ajax

A formlib - ajax integration package providing a new namespace and traverser for widgets.

z3c.authentication

Sub-packages: cookie (cookie based authentication and auto-login)

z3c.authentication.simple

This package provides simple authentication utility for Zope3. It uses generated hash ids for principals. This makes it safe to remove and re-add principals. It also offers a smart way for implement your own custom principal implementations. This is handy if you need to implement an email address or some system specific arguments for your principal objects.

z3c.authenticator

A reimplementation of the zope.app.authentication pluggable authentication utility that makes it easier to associate principals to custom information.

z3c.autoinclude

Autoloads packages and their configuration based on dependencies specified for a another package in its setup.py file.

z3c.baseregistry

Allows configuring and defining local sites and components via ZCML. Think, for example, defining adapters at the site level instead of globally.

z3c.batching

A simple batching implementation that helps with the management of batching. (Batching = splitting a long list of elements in several pages)

z3c.blobfile

This package provides an implementation of zope.app.file.interfaces.IFile? which uses the Blob support introduced in ZODB 3.8. It's main purpose is to provide an easy migration path for existing instances. For more advanced file implementations see zope.file and z3c.extfile.

z3c.boston

A skin built on top of zope.app.boston in order to support pagelets, z3c.form and z3c.formjs.

z3c.breadcrumb

The z3c.breadcrumb package provides base classes for breadcrumb implementations. It allows you to write adapters for each content object which provides it's own rule for providing the breadcrumb name, url and selection.

z3c.componentdebug

Component Debugging provides a set of tools for inspecting the component registry of site managers. It also provides a patch that catches various different ComponentLookupError? exceptions and adds more verbose reporting.

z3c.conditionalviews

This package intergrates with the zope publisher to validate conditional requests based on the If-None-Match, If-Match, and If-Modified-Since, If-UnModifiedSince? protocols.

z3c.configurator

A dependency-tracking plugin-based utility to configure components after their initial creation. Usually it can be used to configure site utilities after the site object is created.

z3c.contents

This package provides a contents.html page replacement for Zope3 based on z3c.form and z3c.table.

z3c.coverage

Script to convert unit test coverage reports to HTML.

z3c.csvvocabulary

Provides simple vocabularies using CSV files, which allows non-developers to update the vocabulary.

z3c.currency

A package implementing a currency field for zope.schema and support for using the field with z3c.form.

z3c.datagenerator

Utilities to quickly create various sample data, useful in developing and testing applications.

z3c.dav

An implementation of the WebDAV? protocol for Zope 3.

z3c.davapp.zopeappfile

This package defines and implements the WebDAV? data model for all zope.app.file.file.File content objects.

z3c.davapp.zopefile

This package defines defines the WebDAV? data model for all zope.file.file.File content objects.

z3c.davapp.zopelocking

Package to contain all the code to make WebDAV? locking work with the zope.locking package. This is pretty much just of copy of the lockingutils, ftests/tests_z3_locking and tests modules from z3c.dav.

z3c.demo

Demos for z3c.website. Contains demos for Howto and Calculator ??

z3c.discriminator

Provides a formalism for marking adapter specifications as discriminators in the sense that they will be used only for adapter lookup, not instantiation.

z3c.dobbin

Dobbin is an object database implemented on top of SQLAlchemy. It's designed to mimick the behavior of the Zope object database (ZODB) while providing greater flexibility and control of the storage.

z3c.encryptedpersistent

This package provides integration with persistent objects. Ususally, objects are stored in the ZODB in plain text. The EncryptedPersistent? base class ensures that all data of the class is encrypted before being stored.

z3c.etestbrowser

This package is intended to provide extended versions of the Zope 3 testbrowser. Especially those extensions that introduce dependencies to more external products, like lxml.

z3c.etree

Provides a proxy for various ElementTree? implementations by implementing an utility and various proxy objects for actual ElementTree?-implementing libraries.

z3c.evalexception

paste.evalexception lets you interactively debug exceptions in your WSGI app. z3c.evalexception is a small wrapper around that so that it works with the stock Zope 3 application server.

z3c.extfile

This package offers large file handling solutions for zope3. The first implementation is based on properties, the second on wsgi. The property implementation runs on plain zope 3.

z3c.filetype

This package provides a way to get interfaces that are provided based on their content, filename or mime-type. Still in development.

z3c.flashmessage

Components to display small messages to users.

z3c.form

Provides various hooks, namespaces and utilities to enhance the widgets and formlib for various purposes, including AJAX type of development.

z3c.formdemo

This package contains several small demo applications for the z3c.form and z3c.formui packages: Table vs div based layouts, simple 'Hello world' demo, a calculator demo, a linear wizard showing the subform capabilities, and a table/spreasheet example, showing how to use z3c.form with zc.table

z3c.formext

This package provides integration of ExtJS? into the z3c.form framework.

z3c.formjs

Package that provides javascript support/enhancements to the z3c.form library.

z3c.formjsdemo

This package is going to show off the different features of the z3c.formjs package.

z3c.formui

This package provides a set of default layouts for the z3c.form framework. In particular it provides a DIV-based and a TABLE-based layout. The developer can use either layout by inheriting from a different base layer.

z3c.formwidget.query

This package implements a widget that lets users enter a query and select from the results.

z3c.formwidget.traverser

This is a port from z3c.widget.namespace designed for zope.formlib that now works for z3c.form widgets.

z3c.gibberish

Generate CSV files containing random words from a dictionary

z3c.i18n

i18n related convinience modules: translation domains for language names and territories and two vocabularies that contain all the languages and territories.

z3c.image

Image processor and utilities via PIL

z3c.imagewidget

Based on z3c.sessionwidget, it offers a set of forms to provide an image widget that displays and updates its data before the form is really submitted.

z3c.indexer

This package provides an implementation for indexing objects and query indexes for Zope3. This will make zope.app.catalog obsolate.

z3c.indexing.dispatch

This package implements a transaction-safe indexing dispatcher, with a pluggable indexing architecture; Indexing operations are deferred to right after the request has ended, exhibiting asynchronous behavior. All operations are carried out in the thread that committed the tranaction; The operation queue is optimized to avoid unnecessary indexing.

z3c.iplocation

This package implements an IP locator utility, which allows to look up the location (country, city, etc) for a given IP address.

z3c.javascript

Contains various javascript libraries packaged for zc.resourcelibrary: dojo, jquery, json, mochikit, prototype, scriptaculous, swfobject.

z3c.jbot

The z3c.jbot (or "Just a bunch of templates") package allows drop-in page template overrides. It works by giving page templates a canonical filename which you can use to provide a replacement in your own package. Simply register a template overrides directory and give your new template the canonical filename.

z3c.json

This package provides basic JSON components like JSON reader and writer utilities and a JSON-RPC client proxy including the transport implementation for Zope3.

z3c.jsonrpc

This package provides an JSON-RPC server implementation for Zope3.

z3c.jsonrpcproxy

This package provides an JSON-RPC (javascript) proxy used for Zope3. But the javascript itself does not depend on any zope library and can be used with any other JSON-RPC server. Note the xmlhttp request javascript library form z3c.xmlhttp is required for this implementation

z3c.jsontree

This package provides an JSON-RPC item tree implementation for Zope3. It depends on z3c.json, z3c.jsonrpc, z3c.template

z3c.language.negotiator

This package provides a persistent INegotiator? utility implementation, which allows you to set a policy on the way the language is determined for a user interaction.

z3c.language.session

Provides a simple mechanism to store a language preference in a session.

z3c.language.switch

This is the "beef" of the z3c.language.* packages, it allows you do implement internationalized content items.

z3c.layer.minimal

Serves as a minimal base layer to be used in developing new sites not based on the default browser layer

z3c.layer.pagelet

A base layer to be used when developing sites based on the z3c.pagelet patern.

z3c.layer.ready2go

This package provides a layer based on z3c.form and z3c.pagelet. This layer can

be used in custom skins.

z3c.layer.trusted

The difference to the minimal layer is that this layer has trusted traverser adapters. This means that the views get access to objects that are not wrapped in a security proxy.

z3c.layout

This package implements a page rendering model based on a static HTML document that is made dynamic from the outside by mapping content provider definitions to locations in the HTML document tree. This is called a "layout".

z3c.livesearch

Provdes an AJAX based livesearch using scriptaculous and prototype

z3c.listjs

A list widget that uses Javascript to enhance its functionality

z3c.locales

This package provides the translation for the z3c packages which using the shared z3c domain.

z3c.macro

This package provides an adapter and a TALES expression for a more explicit and more flexible macro handling using the adapter registry for macros.

z3c.macroviewlet

Allows the declaration of a macro in a template as a viewlet

z3c.menu.simple

z3c.menu.simple, a simple menu implementation which allows you to implement simply menus based on content providers and viewlets.

z3c.menu.ready2go

This package provides a ready 2 go menu implementation based on viewlets for Zope3.

z3c.metrics

Metrics define the values that constitute the score for an object in a given metric index. Metrics update an object's score incrementally and as such can only use values whose both previous and new values can be retrieved on change.

z3c.mountpoint

This package provides a very simple implementation of a mount point for an object in another ZODB connection. If you have multiple connections defined in your zope.conf configuration file or multiple databases defined in your Python code, you can use this package to mount any object from any database at any location of another database.

z3c.multiform

This Package provides an API to handle multiple forms with matching form fields on multiple items. The creation of multiforms is derived from the Form class of the formlib package.

z3c.objectpolicy

The objectpolicy package makes it easy to override the default zope.app.securitypolicy.zopepolicy on an object by object basis.

z3c.objpath

Utilities to get the full path of an object or to get an object based on its path. Allows application to define the way object paths are defined and resolved

z3c.offlinepack

Pack a ZODB storage without running any part of the Zope application server. Only an appropriate version of Zope for the ZODB storage is required. Use on a copy of a ZODB storage. Do not run on a ZODB storage currently in use.

z3c.optionstorage

This is a generic solution for including editable and multi-lingual vocabulary-like information in any annotatable object.

z3c.pagelet

This package provides a very flexible base implementation for write view like components which can be higly customized later in custom project. This is needed if you have to write reusable components like needed in a framework. It does this by spliting the template registration from the view registration and providing content template / layout template.

z3c.password

This package provides an API and implementation of a password generation and verification utility. A high-security implementation is provided that is suitable for banks and other high-security institutions. The package also offers a field and a property for those fields.

z3c.pdftemplate

Provides the functionality of creating browser views that generate PDFs? instead of HTML using reportlab's PDF writer technology. Also provides integration with z3c.rml

z3c.persistentfactory

Provides a Persistentfactory class that wraps a method in a persistent wrapper. It also provides a function decorator for use on class method definitions such that a persistent factory will be used when the method is accessed on instance of the class

z3c.profiler

This package provides a profiler skin which allows you to profile pages.

z3c.proxy

This package provides a proxy container implementation for Zope3, that is a container that will proxy other containers.

z3c.pt

The z3c.pt package provides an alternative implementation of the TAL template language. In a nutshell: Templates are bytecode-compiled, Only Python-expressions are supported, Depends only on lxml

z3c.pypimirror

This package provides a mirror for the PyPI? simple interface.

z3c.quickentry

The quick entry processor allows a user to efficiently specify multiple values in one larger text block. The processor uses plugins to dynamically define the commands to handle. This type of input is not aimed at the average user, but at power users and users that can be trained. The syntax is purposefully minimized to maximize the input speed. This method of entry has been verified in a real life setting.

z3c.recipe.dev

Includes 2 recipes: z3c.recipe.app, to generate a z3 app and z3c.recipe.script, to generate a script runner that has all the necessary eggs configured.

z3c.recipe.egg

Recipes based on zc.recipe.egg for working with source distributions. Contains z3c.recipe.egg:setup, which calls arbitrary setup.py commands on multiple distributions in a buildout.

z3c.recipe.eggbasket

A recipe to build a tarball out of a package and its dependencies.

z3c.recipe.fakezope2eggs

This buildout recipe will simply add some fake egg link to zope libraries (installed inside zope/lib/python/zope/...) so that setuptools can see that the dependencies are already satisfied and it won't fetch them anymore.

z3c.recipe.i18n

Offers different tools which allows to extract i18n translation messages from egg based packages.

z3c.recipe.filetemplate

With the z3c.recipe.filetemplate buildout recipe you can automate the generation of text files from templates. Upon execution, the recipe will read a number of template files, perform a simple variable substitution and write the result to the corresponding output files.

z3c.recipe.ldap

This recipe can be used to deploy an OpenLDAP? server in a zc.buildout. More specifically it provides for initializing an LDAP database from an LDIF file and for setting up an LDAP instance in the buildout. This recipe can also be used to provide an isolated LDAP instance as a test fixture.

z3c.recipe.openoffice

This recipe download openoffice in your buildout, it can also (optional) create egg with pyuno and change the default python used by openoffice.

z3c.recipe.paster

The z3c.recipe.paster:serve generates a paste deploy serve scripts and configuration files for starting a paste deploy based Zope 3 setup. The paste deploy *.ini file content can get defined in the buildout.cfg file.

z3c.recipe.perlpackage

The perlpackages recipe automates installation of Perl packages. This recipe is similar to zc.recipe.cmmi, but instead of performing "configure, make, make install" it uses "perl Makefile.PL" for the configure step.

z3c.recipe.runscript

This run-script URL allows you to specify an arbitrary script to do the work of the recipe.

z3c.recipe.sphinxdoc

This buildout recipe aids in the generation of documentation for the zope.org website from restructured text files located in a package. It uses Sphinx to build static html files which can stand alone as a very nice looking website.

z3c.recipe.tag

This recipe generates a TAGS database file that can be used with a number of different editors to quickly lookup class and function definitions in your package's source files and egg dependencies.

z3c.recipe.winservice

Generates a service scripts and configuration files for starting a egg based Zope 3 setup as a windows service.

z3c.reference

Provides a reference engine, to be used with objects and schemas.

z3c.referrercredentials

A package that uses the HTTP referer header to provide credentials.

z3c.relationfield

This package implements a new schema field Relation, a widget for relations, and the Relation objects that store actual relations. In addition it can index these relations using the zc.relation infractructure, and therefore efficiently answer questions about the relations.

z3c.reload

A package that automatically reloads view code on the fly eithout the need to restart a server.

z3c.repoexternals

Recursively retrieves subversion directory listings from the url or path and matches directories against a previous set of svn:externals if provided then against regular expressions and generates qualifying svn:externals lines. The defaults generate a set of svn:externals for all the trunks in a repository and keeps them up to date with the repository as new trunks are added when the previous externals are provided thereafter.

z3c.resource

Allows content objects to provide resources by allowing themselves to be traversed via the ++resource++ namespace.

z3c.resourcecollector

Allows merging of browser resources (css, js) into one file, to reduce HTTP requests.

z3c.resourceinclude

A package similar in purpose with zc.resourcelibrary that makes it possible to include resources in a rendered page based on a condition (in this case, a browser layer/interface) and the dependency that was setup between that layer and the resource names.

z3c.responseheaders

This package provides an implementation for setting response headers (e.g. for cache-control settings) on browser views by registering views on views. This way we do not have to change view code in order to set headers differently.

z3c.rest

This package implements several components that relate to building RESTive? Web services using the Zope publisher.

z3c.restdemo

This package contains several small demo applications for the z3c.rest package.

z3c.rml

An open source implementation of the RML language, to be used with ReportLab? to generate PDF files.

z3c.rmldocument

Provides a document object that has user-editable blocks of RML within a defined RML template. Also provides a UI widget for editing an RML subset and choose fields that should get dynamically embedded.

z3c.rotterdam

A version of the rotterdam skin which supports z3c.pagelet and z3c.form

z3c.saconfig

Provides a system to configure the Zope/SQLAlchemy sessions.

z3c.sampledata

This package tries to do the best to support the development of sample data generators. A sample data generator is a pluggable tool to create data needed for tests.

z3c.schema

Provides several extension fields to be used in schema definitions: baseurl - useful if you need to append view names to a url and don't like to check every time if the url ends with a backslash before you append the view name; email - holds and validates email addresses; hostname - holds and validates IPs? and hostnames; ip - holds and validates IPs?; optchoice - a field that allows either to select a choice from a vocabulary or enter a custom value; regex - holds and validates regular expressions;

z3c.schema2xml

This package can convert objects described by Zope 3 schema to simple XML structures. It's also able to convert this XML back into objects. The export and import processes are completely schema-driven; any attribute not described in the schema is not seen by this system at all.

z3c.schemadiff

A diff tool that bridges zope.schema with difflib. It allows you to take two objects and retrieve a field-by-field diff; fields are chosen based on all implemented interfaces, unless explicitly specified. A browser view is included to easily display a diff between two objects using difflib's HtmlDiff?-class.

z3c.searcher

This package provides an implementation for build search forms for Zope3.

z3c.searchfilter

Browser pages and utilities to perform and filter catalog searches

z3c.securitytool

z3c.securitytool is a Zope3 package aimed at providing component level security information to assist in analyzing security problems and to potentially expose weaknesses. The goal of the security tool is to provide a matrix of users and their effective permissions for all available views for any given component and context. We also provide two further levels of detail. You can view the details of how a user came to have the permission on a given view, by clicking on the permission in the matrix.

z3c.sessionwidget

This package provides a widget that is only responsible for relaying the data of interest to a session. A sub-form or any other component can then use this session data and provide new data, if desired. The session data will also be publically available via a URL, so that the objects can also be displayed, such as images. This has the advantage that the data is not stored on the content until the overall form is submitted.

z3c.skin

A pagelet based Zope skin.

z3c.skin.pagelet

The z3c.skin.pagelet package provides a skin for the z3c.pagelet package. Note, the pagelet skin is only registered in the test layer. You can use this skin as a base for your own skins or just use it as a sample for the z3c.pagelet package.

z3c.skin.ready2go

This package provides an implementation for basic skins.

z3c.sqlalchemy

A SQLAlchemy wrapper for Zope 2/3. The functionality of the wrapper is basically focused on easy integration with Zope 2 and Zope 3. The wrapper cares about connection handling, optional transaction integration with Zope 2/3 and wrapper management (caching, introspection). z3c.sqlalchemy gives you flexible control over the mapper creation. Mapper classes can be either auto-generated (with or without autodetection of table relationships) or configured by the developer. What z3c.sqlalchemy does not do and won't do: no support for Zope 3 schemas and no support for Archetypes schemas

z3c.table

This package provides an modular table rendering implementation for Zope3.

z3c.tan

A Transaction Authorization Number, short TAN, is a security feature to give a principal additional permissions for a limited amount of time, either one transaction or a short time span, like a day or a week. This package implements a TAN system as a plugin to the authentication utility in zope.app.authentication

z3c.template

This package allows the separation of the registration of the view code and the layout (template). Similar, but has more features than z3c.viewtemplate

z3c.testing

Test Helpers for Zope3

z3c.testsetup

A package that provides some convenience stuff to enable rapid test setup for Zope 3 components and normal Python packages. Currently doctests (normal unit doctests and functional doctests) and usual Python tests made of unittest.TestCase? definitions are supported.

z3c.themehook

This package contains a publication object that provides a hook for callObject,

so that the calling gets pluggable. The main reason for this is to apply theming, which is why the module is called "themehook".

z3c.traverser

A pluggable traverser for Zope 3 objects, which allows developers to develop new ways of composing URLs? and traverse to objects.

z3c.unconfigure

This is a package that allows you to disable specific bits of ZCML that may occur in other packages.

z3c.vcsync

Takes an arbitrary object and syncs it through SVN. This means a serialization to text, and a deserialization from text. The text is stored in a SVN checkout. Newly appeared texts are svn added, removed texts are svn removed. svn move and svn copy are not supported. They will instead cause a svn delete/svn add combination.

z3c.versionedresource

Versioned Resources insert a version number in the URL of a resource, so that cache behavior can be customized

z3c.viewlet

Provides an weight ordered viewlet manager.

z3c.viewtemplate

Separate the template registration from the view code.

z3c.weblog

This package provides a weblog implementation for Zope 3.

z3c.website

The code that runs (will run) www.z3c.org

z3c.wfmcpersistent

This package has exactly the same functionality as the zope.wfmc, but all classes are redefined as persistent to be able to store the complete workflow process definition in the ZODB.

TODO: insert z3c.widget packages

z3c.widget.namespace

A custom traverser that allows getting rendered widgets independently of the form, by using the ++widget++ namespace. Useful mostly in AJAX based views.

z3c.wizard

This package provides a form wizard concept based on z3c.form for Zope3.

z3c.xmlhttp

This package provides an XMLHttpRequest? implementation which is used as base javascript library for z3c.jsonrpcproxy. This library can be used in other javascript projects if you need a XHR implementation.

z3c.zalchemy

Integrates the object relational mapper SQLAlchemy into Zope 3 as SQLOS integrates sqlobject. zalchemy tries to do its best not to interfere with the standard SQLAlchemy usage. The main part of zalchemy is the integration of the SQLAlchemy transaction into the Zope transaction. This is solved by using a data manager which joins the Zope transaction for every newly created thread.

z3c.zodbbrowser

The ZODB Browser is a wxPython client application which can visualize the ZODB internals. After starting the ZODB Browser, you can open a Data.fs and traverse the database objects in a tree view.

z3c.zodbtracing

Package is meant to aid debugging/tracing ZODB. A special case was to determine from which point of the application a huge amount of object loading comes.

z3c.zrtresource

A simple templating engine to be used in generating free-form resources (not XML) - CSS files, JavaScript?, etc.

Zope Corporation packages

zc.rebootstrap

Helper package to re-bootstrap packages for RPM construction.

zc.async

The zc.async package provides a way to make scalable asynchronous application calls.

zc.authorizedotnet

Authorize.Net provides credit card processing via a protocol on top of HTTPS.

zc.buildout

The Buildout project provides support for creating applications, especially Python applications. It provides tools for assembling applications from multiple parts, Python or otherwise. An application may actually contain multiple programs, processes, and configuration settings.

zc.buildoutsftp

Provides a zc.buildout extension that provides support for SFTP.

zc.catalog

Is an extension to the Zope 3 catalog, Zope 3's indexing and search facility. zc.catalog contains a number of extensions to the Zope 3 catalog, such as some new indexes, improved globbing and stemming support, and an alternative catalog implementation.

zc.comment

The comment package is a simple way to add comments to any IAnnotatable? Zope content. The datetime and current principals are stamped on to the comment. The comment body is currently simply unicode text but intended to be html snippets ("rich text") at a later date.

zc.copy

This is a Zope 3 extension that helps with pluggably copying objects.

zc.creditcard

Credit card utilities. Right now it only has a utility to detect credit card type.

zc.datetimewidget

Offers a popup javascript widget to enter dates.

zc.dict

A BTree?-based persistent dict-like object that can be used as a base class. This is a bit of a heavyweight solution, as every zc.dict.Dict is at least 3 persistent objects. Keep this in mind if you intend to create lots and lots of these.

zc.displayname

A Zope 3 extension for pluggable display names. This could be used to generate names for content in lists or breadcrumbs.

zc.extrinsicreference

Extrinsic registries record a key and one or more values to which they refer.

zc.form

Contains various extra fields and widgets. (Most Recent Used widget, Union widget, Combination widget, etc)

zc.freeze

Pattern for freezing objects. State is informational--enforcement unspecified. Some enforcement approaches and helpers are included.

zc.i18n

Some date and duration conveniences, needed in zope.locking.browser.

zc.index

Provides various adapters that provide for searchable text extraction. Many of these adapters require running external applications over data stored in file objects (as defined in the zope.file package)

zc.iso8601

This package collects together functions supporting the data formats described in ISO 8601. Time zone support is provided by the pytz package. ISO 8601 is an international standard for date and time representations

zc.listcontainer

A Zope-3-aware pseudo-list that generates events upon changes and maintains linked list information on its members. The difference to a standard container is that the standard container resembles a dictionary, while this imitates a list.

zc.mirrorshop

This package provides a mirror for the PyPI? simple interface, http://cheeseshop.python.org/simple/.

zc.ngi

Network programs are typically difficult to test because they require setting up network connections, clients, and servers. In addition, application code gets mixed up with networking code. The Network Gateway Interface (NGI) seeks to improve this situation by separating application code from network code. This allows application and network code to be tested independently and provides greater separation of concerns.

zc.notification

Simple user notification framework. Currently includes email notification

zc.objectlog

The objectlog package provides a customizable log for a single object. The system was designed to provide information for a visual log of important object changes and to provide analyzable information for metrics. - It provides automatic recording for each log entry of a timestamp and the principals in the request when the log was made. - Given a schema of data to collect about the object, it automatically calculates and stores changesets from the last log entry, primarily to provide a quick and easy answer to the question "what changed?" and secondarily to reduce database size. - It accepts optional summary and detail values that allow the system or users to annotate the entries with human-readable messages. - It allows each log entry to be annotated with zero or more marker interfaces so that log entries may be classified with an interface.

zc.preview

This package contains a variety of preview views that are otherwise isolated. The previews are done based on the mimetype.

zc.queue

Queues that are optimized for persistency via the ZODB.

zc.recipe.cmmi

The configure-make-make-install recipe automates installation of configure-based source distribution into buildouts.

zc.recipe.deployment

The zc.recipe.deployment recipe provides support for deploying applications with multiple processes on Unix systems. (Perhaps support for other systems will be added later.) It creates directories to hold application instance configuration, log and run-time files. It also sets or reads options that can be read by other programs to find out where to place files.

zc.recipe.filestorage

This recipe can be used to define a file-storage. It creates a ZConfig file-storage database specification that can be used by other recipes to generate ZConfig configuration files

zc.recipe.rhrc

The zc.recipes.rhrc recipe creates Red-Hat Linux (chkconfig) rc scripts. It can create individual rc scripts, as well as combined rc scripts that start multiple applications.

zc.recipe.testrunner

This recipe generates zope.testing test-runner scripts for testing a collection of eggs. The eggs must already be installed (using the zc.recipe.egg recipe).

zc.recipe.zeo

The ZEO instance recipe (zc.recipe.zeoinstance) creates a ZEO instance.

zc.recipe.zeoinstance

This recipe creates a basic ZEO instance.

zc.recipe.zope3checkout

Recipe for creating a Zope 3 checkout in a buildout.

zc.recipe.zope3instance

This recipe creates a Zope instance that has been extended by a collection of eggs.

zc.relationship

Low-level ZODB relationship index: supports intransitive and transitive n-ary relationships. Example usage of "relationship containers".

zc.resourcelibrary

The resource library is designed to make the inclusion of JavaScript?, CSS, and other resources easy, cache-friendly, and component-friendly. For instance, if two widgets on a page need the same JavaScript? library, the library should be only loaded once, but the widget designers should not have to concern themselves with the presence of other widgets.

zc.security

Enhanced UI for searching for principals: This package provides some Zope 3 user interfaces for searching for principals managed by the pluggable authentication utility.

zc.selenium

This package provides an easy way to use Selenium tests for Zope 3 applications. It provides Selenium itself as a resource directory, and it provides a test suite listing generated from registered views, allowing different packages to provide tests without a central list of tests to be maintained.

zc.set

Persistent sets are persistent objects that have the API of standard Python sets. The persistent set should work the same as normal sets, except that changes to them are persistent.

zc.sharing

"Sharing" Security Policy for Zope 3.

zc.shortcut

Symlinks for Zope 3.

zc.site

The zc.site.search module includes tools to support copying search results to the clipboard, which can be used for both portlet and non-portlet uses of searching. The support provided requires that search results are represented by sets of int ids and are presented using a table formatter based on zc.table.

zc.sourcefactories

Source factories are used to simplify the creation of sources for certain standard cases. Sources split up the process of providing input fields with choices for users into several components: a context binder, a source class, a terms class, and a term class.

zc.sshtunnel

This recipe creates a control script for an SSH tunnel. This is only expected to work on systems with the OpenSSH? "ssh" binary on $PATH, and may require setting up the SSH configuration to use the expected usernames for each system.

zc.table

This is a Zope 3 extension that helps with the construction of (HTML) tables. Features include dynamic HTML table generation, batching and sorting.

zc.tokenpolicy

The tokenpolicy package supplies a modified sharing policy that honors tokens from the zope.locking package.

zc.twist

The twist package contains a few functions and classes, but primarily a helper for having a deferred call on a callable persistent object, or on a method on a persistent object. This lets you have a Twisted reactor call or a Twisted deferred callback affect the ZODB. Everything can be done within the main thread, so it can be full-bore Twisted usage, without threads.

zc.vault

Low-level versioning support similar to revision control systems, with an example usage and several example add-ons. ZODB-friendly.

zc.winauth

This package provides for authenticating windows users with their domain user names and passwords.

zc.z3monitor

The Zope 3 monitor server is a server that runs in a Zope 3 process and that provides a command-line interface to request various bits of information.

zc.zdaemonrecipe

The zdaemon recipe provides support for generating zdaemon-based run scripts.

zc.zodbactivitylog

This package provides an activity log that lets you track database activity.

zc.zodbrecipes

Recipes for working with ZODB.

zc.zope3recipes

Somewhat experimental recipes for creating Zope 3 instances with distinguishing features: - Don't use a skeleton- Separates application and instance definition - Don't support package-includes

zc.yuiresource

YUI Javascript library packaged as zc.resourcelibrary resource.

zam packages

ZAM is Zope Application Management, a replacement of the classic ZMI using a new skin based on pagelets and plugins for management.

zam.api

Holds the API of the ZAM (Zope Application Management)

zam.demo

A demo package to bind all other related ZAM packages in an easy to use demo of ZAM

zam.locales

Contains translation files for the ZAM

zam.skin

The ZAM skin, based on pagelets and z3c.form

zam.plugincontrol

Implements activatable plugins for ZAM, using z3c.baseregistry

zamplugin.error

An implementation of a error utility, bundled as a zam plugin

zamplugin.navigation

This package provides an navigation plugin for ZAM (Zope 3 Application Management).

zamplugin.sampledata

A plugin that integrates z3c.sampledata into ZAM

zamplugin.sitemanager

This package provides a site management for ZAM (Zope 3 Application Management).

zamplugin.authenticator

This package provides a z3c.authenticator management for ZAM

z3ext packages

z3ext packages are part of a complete z3 CMS system. Many z3ext packages depend on the full z3ext infrastructure, but the packages published on svn.zope.org are general and independent enough to be used in any Zope project. See more details at http://z3ext.net/

z3ext.cacheheaders

Provides a new publication factory which uses customizable caching strategies to set cache headers in the request.

z3ext.controlpanel

A package that makes it possible to centralize various module configuration in a control panel, using confliglets. Depends on z3ext.layout and z3ext.layoutform.

z3ext.cssregistry

Provides a zcml extension that enables defining and overriding named variables that would be inserted in css files (for example, colors). Depends on and also provides an extension for z3c.zrtresource

z3ext.formatter

Adds an extension to TALES that helps in displaying formatted dates using site definable timezones. Depends on z3ext.controlpanel

z3ext.layout

This package makes it possible to define "layouts" for pages and views. Layouts can be nested and overridable per context type. Requires z3ext.statusmessage

z3ext.layoutform

z3c.form extension that integrates forms with layouts defined through z3ext.layout. Requires, of course, z3ext.layout.

z3ext.lucene

A zc.catalog extension index that uses Apache Lucene index to achieve fulltext search. Jython is required. Only depends on zc.catalog

z3ext.ownership

This package implement single ownership concept. Content owner has special role on content content.Owner. Requires z3ext.security

z3ext.pathindex

A zc.catalog extension index that indexes the traversal path of an object.

z3ext.profiler

An easy to use cProfile based profiler. It provides a way to monkeypatch the WSGI publisher at runtime to hook up and release the profiler.

z3ext.skintool

Provides means to define requirement relations between layers and to change the request at runtime to provide different layers, for the purpose of allowing runtime selection of skins for ISite? objects.

z3ext.statusmessage

Provides a way to define and render status messages.

Credits

This list was originally taken from the blog post: http://play.pixelblaster.ro/zope-plone-tips/the-complete-guide-to-svn.zope.org-packages