ZODB3 README file
Please see the LICENSE.txt file for terms and conditions.
Andrew Kuchling's ZODB/ZEO Programming Guide is provided verbatim under the terms of the GNU Free Documentation License.
The ZODB3 package provides a set of tools for using the Zope Object Database (ZODB) in Python programs separately from Zope. The tools you get are identical to the ones provided in Zope, because they come from the same source repository. They have been packaged for use in non-Zope stand-alone Python applications.
ZODB3 is known to work with Python 2.1.3, 2.2, and the not-yet-released 2.3. For best results, we recommend using Python 2.1.3 or Python 2.2.2. Note that 2.2.1 does not work.
Our primary development platform is Linux, but we also test on Windows 2000 and 98. The test suite should pass without error on all of these platforms, although it can take a long time on Windows.
The components you get with the ZODB3 release are as follows:
- Core ZODB, including the persistence machinery
- Standard storages such as FileStorage
- Supporting modules such as ExtensionClass
- The persistent BTrees modules
- Experimental Berkeley storages
- ZConfig -- a Zope configuration language
- Some documentation <wink>
You must have Python installed. If you've installed Python from RPM, be sure that you've installed the development RPMs too, since ZODB3 builds Python extensions. If you have the source release of ZODB3, you will need a C compiler.
If you intend to use the experimental Berkeley storages, you will need to install the Berkeley database software and PyBSDDB, the next generation of Berkeley DB Python wrapper. It is recommended that you use at least Berkeley 4.0.14 and PyBSDDB 3.4.0.
The ZConfig package requires an XML parser with SAX support. If you have Python 2.1, you should probably install the PyXML package. If you have Python 2.2, the pyexpat module should be sufficient; note that pyexpat requires expat be installed.
ZODB3 is released as a distutils package. To build it, run the setup script:
% python setup.py build
To test the build, run the test script:
% python test.py
For more verbose test output, append one or two '-v' arguments to this command.
If all the tests succeeded, you can install ZODB3 using the setup script:
% python setup.py install
This should now make all of ZODB accessible to your Python programs. You can test this by cd'ing to your home directory and typing the following commands:
Python 2.2.2 (#1, Oct 18 2002, 15:34:34) [GCC 2.95.3 19991030 (prerelease)] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import ZODB >>> ZODB.__version__ '3.2a1'
ZODB3 comes with a large test suite that can be run from the source directory before ZODB is installed. The simplest way to run the tests is:
% python test.py -v
This command will run all the tests, printing a single dot for each test. When it finishes, it will print a test summary. The exact number of tests can vary depending on platform and available third-party libraries. On Windows, the tests can take much longer to execute:
Ran 1374 tests in 1706.841s OK
The test script has many more options. Use the -h or --help options to see a file list of options.
The version numbering scheme for ZODB is complicated. Starting with this release, we are trying to make it simpler. This is release 3.1.1 of the package named ZODB3. Versions prior to 3.1 had different names and different numbers. This section describes the gory details.
Historically, ZODB was distributed as a part of the Zope application server. Jim Fulton's paper at the Python conference in 2000 described a version of ZODB he called ZODB 3, based on an earlier persistent object system called BoboPOS. The earliest versions of ZODB 3 were released with Zope 2.0.
Andrew Kuchling extracted ZODB from Zope 2.4.1 and packaged them for use by standalone Python programs. He called this version "StandaloneZODB". Andrew's guide to using ZODB is included in the Doc directory. This version of ZODB was hosted at http://sf.net/projects/zodb. It supported Python 1.5.2, and might still be of interest to users of this very old Python version.
Zope Corporation released a version of ZODB called "StandaloneZODB 1.0" in Feb. 2002. This release was based on Andrew's packaging, but built from the same CVS repository as Zope. It is roughly equivalent to the ZODB in Zope 2.5.
Why not call the current release StandaloneZODB 1.1? The name StandaloneZODB is a bit of a mouthful. The standalone part of the name suggests that the Zope version is the real version and that this is an afterthought, which isn't the case. Finally, we started work on ZODB4 -- a major new version based on Python 2.2 new-style types instead of ExtensionClass. So we're calling this release "ZODB3". We settled on the 3.1 version number so that we don't create the impression that this version of ZODB is the same as the one Jim described as ZODB 3 in 2000.
We maintain a Wiki page about all things ZODB, including status on future directions for ZODB. Please see
and feel free to contribute your comments. There is a Mailman mailing list in place to discuss all issues related to ZODB. You can send questions to
or subscribe at
and view its archives at
Andrew's ZODB Programmers Guide is made available in several forms, including DVI and HTML. To view it online, point your browser at the file Doc/guide/zodb/index.html