ZODBData Framework

February, 2008

Abstract

The ZODBData Framework provides a Cocoa® interface for persistent objects stored in a Zope Object Database (ZODB).


Table of Contents

Overview
License
Documentation
Requirements
Sourcecode
Building
Testing
Distribution
Install
Contact

Overview

The ZODBData Framework contains a dynamic library and its headers to provide a common API for connecting to a Zope Object Database. Objects stored in such a database will be handled more or less like NSData objects. So the software developer does not need to care about opening/closing the database connection or committing changes. The framework holds its own connection registry internally. In that way a ZODB can be an alternative to Apple's property lists or sqlite. The framework uses the PyObjC bridge to provide proxy classes for wrapping objects stored in the ZODB.

License

Zope Public License, Version 2.1 (ZPL)

Documentation

Browse the API documentation.

Requirements

Sourcecode

Use svn co http://zodbdata.svn.sourceforge.net/svnroot/zodbdata/branches/buildout-branch ZODBData to check out the source files.

Browse the SVN repository.

Building

The ZODBData Framework is built using the conventional configure/make pattern on Mac OS X.

There are only a couple of options to the configure script, but you won't need either of them in the common case. The configure script will check for the required Python packages.

Since zc.buildout is used for the python part, the required resources will be installed locally during the build process.

  $ ./configure
  checking for doxygen... yes
  creating: Makefile
  creating: python/Makefile
  creating: bin
  creating: bin/mkzeoinstance
  creating: bin/test
  creating: Description.plist
  creating: doxygen.cfg

  $ make

Testing

The configure script will also create a script for testing purposes, called test. You can run this directly after configure.

$ bin/test

Distribution

Once you successfully built the framework, you can simply make an installer package by typing:

$ make dist

Install

The make target install invokes the Apple Installer application.

$ make install

Contact

For further information, questions and suggestions visit the project page or contact rodaebel (at) users (dot) sourceforge (dot) net.