[Zope-CVS] CVS: Products/Ape - CHANGES.txt:1.11 README.txt:1.5 SQL.txt:1.2 __init__.py:1.6 component.xml:1.8 dbtab.conf:1.6 version.txt:1.7

Shane Hathaway shane at zope.com
Thu Mar 25 23:59:40 EST 2004

Update of /cvs-repository/Products/Ape
In directory cvs.zope.org:/tmp/cvs-serv13733

Modified Files:
	CHANGES.txt README.txt SQL.txt __init__.py component.xml 
	dbtab.conf version.txt 
Log Message:
Updated docs

=== Products/Ape/CHANGES.txt 1.10 => 1.11 ===
--- Products/Ape/CHANGES.txt:1.10	Sat Feb 28 15:14:33 2004
+++ Products/Ape/CHANGES.txt	Thu Mar 25 23:59:38 2004
@@ -62,8 +62,20 @@
     paths as OIDs.  This solved problems with moving and replacing
     objects.  It also removed the need for a monkey patch and several
     hacks.  Overall, connections with the filesystem are now much more
-    robust, but it is also necessary to maintain an index of OIDs to
-    paths.
+    robust, but it is also necessary to maintain an in-memory index of
+    OIDs to paths.
+  - Restructured SQL database connections to make it easier to cope
+    with the differences between databases.  There is no longer a
+    query generator object.  Instead, the connection generates and
+    executes queries on the fly.
+  - SQLMultiTableProperties, previously experimental, is now the
+    default.  Now, in relational databases, class-defined properties
+    are now assigned their own columns in automatically generated
+    class-specific tables.  Creates columns for strings, integers, and
+    booleans, but more complicated types still get stored in the
+    variable property table.
 Version 0.7.1

=== Products/Ape/README.txt 1.4 => 1.5 ===
--- Products/Ape/README.txt:1.4	Wed Jul  9 11:39:45 2003
+++ Products/Ape/README.txt	Thu Mar 25 23:59:38 2004
@@ -1,103 +1,48 @@
+Quick Start
 Assuming you already have Zope set up and working, follow these steps
-to get started with Ape and DBTab.
+to get started with Ape.
-1. Check your Zope version.  You need at least Zope 2.6.1.
+1. Check your Zope version.  These instructions require Zope 2.7,
+although Ape works with Zope 2.6.
 2. Add the Ape product to Zope by placing it in the Products
 directory.  If you're using an INSTANCE_HOME setup, place it with your
 other add-on products.
-3. Install version 1.2 or later of the DBTab product.  After adding
-the product to Zope, set up custom_zodb.py.  If you're using Unix,
-make a symlink:
-  cd <zope_root>
-  ln -s lib/python/Products/DBTab/custom_zodb.py
-If you're using Windows, make a copy instead.  If you're using an
-INSTANCE_HOME, custom_zodb.py belongs in your INSTANCE_HOME.
-4. Copy the sample dbtab.conf from the Ape product the root of your
-Zope site, or if you're using an INSTANCE_HOME, put it in your
-5. Start Zope.  If Zope refuses to start because "no root database is
-configured", make sure dbtab.conf is in the right place and try again.
-6. Visit the Zope management interface.  Select "DBTab Mount Point"
-from the "add" drop-down.  The checkbox next to "/fs" should be
-enabled.  Click the "Create selected mount points" button.
-7. Visit the new folder /fs and add things to it.  Objects added to
-/fs get stored in the filesystem directory <zope>/var/mnt/fs.  You can
-also add files to <zope>/var/mnt/fs and see them appear in Zope.
-8. To speed up access to /fs, enable the ZODB cache by setting the
-cache size in dbtab.conf to 4000 objects.  The sample dbtab.conf sets
-it to 0, which effectively clears the cache after each request to
-Zope.  With the cache enabled, access to /fs is just as fast as access
-to other Zope objects, but changes made on the filesystem won't be
-reflected immediately in Zope.
-PostgreSQL Connections
-To connect to a PostgreSQL database, install psycopg
-(http://initd.org/software/psycopg) and add the following to
-[Storage: PostgreSQL]
-[Database: PostgreSQL]
-The "params" option specifies how to connect to the database.  If you
-create a default database named the same as your username, you can
-leave "params" blank.
-MySQL Connections
-To connect to a MySQL database, install MySQLdb
-(http://sourceforge.net/projects/mysql-python) and add the following
-to dbtab.conf:
-[Storage: MySQL]
-[Database: MySQL]
-The "kwparams" option specifies how to connect to the database.  (Note
-that psycopg uses "params" while MySQLdb uses "kwparams" because of a
-minor difference in interpretation of the Python DB-API spec.)
-Separate keys and values using a colon and separate multiple options
-using whitespace.
+3. Open component.xml, provided by the Ape product, in a text editor.
+Copy one of the sample configurations to your zope.conf, changing it
+to fit your system.
+4. Start Zope.
+5. If you mounted the database somewhere other than the root, visit
+the Zope management interface.  Select "ZODB Mount Point" from the
+"add" drop-down.  Click the "Create selected mount points" button.
+6. Visit the portion of the object database stored using Ape and add
+things to it.  As you add objects, they will appear on the filesystem
+or in your database.
 A tutorial on the Ape library was prepared and delivered at PyCon
-2003.  The tutorial outline is in the "doc" subdirectory.  The
-accompanying slides, in OpenOffice Impress format, can be downloaded at
-the following URL:
+2003.  The text of the tutorial, called 'outline.txt', is in the 'doc'
+subdirectory.  The accompanying slides, in OpenOffice Impress format,
+are somewhat out of date, but can be downloaded at the following URL:
+Adding New Object Types
+After reading the tutorial, see doc/apexml.txt for instructions on how
+to make Ape aware of other object types.  Although Ape can store any
+kind of ZODB object, Ape stores a Python pickle when no specific
+mapper is provided for a class.  Use apeconf.xml files to configure
+new mappers.

=== Products/Ape/SQL.txt 1.1 => 1.2 ===
--- Products/Ape/SQL.txt:1.1	Sat Mar 20 01:40:57 2004
+++ Products/Ape/SQL.txt	Thu Mar 25 23:59:38 2004
@@ -1,6 +1,9 @@
-Notes on how to set up various databases
+These are notes on how to set up various databases for testing
+purposes.  For a real database, you should set up access controls.
 rm -rf ~/pgsql
 initdb ~/pgsql
@@ -8,6 +11,10 @@
+rm -rf /var/lib/mysql
 /etc/init.d/mysql start

=== Products/Ape/__init__.py 1.5 => 1.6 ===
--- Products/Ape/__init__.py:1.5	Sat Mar 20 01:34:21 2004
+++ Products/Ape/__init__.py	Thu Mar 25 23:59:38 2004
@@ -11,7 +11,7 @@
-"""Ape -- Adaptable Persistence.
+"""Ape -- Adaptable Persistence Engine.

=== Products/Ape/component.xml 1.7 => 1.8 ===
--- Products/Ape/component.xml:1.7	Thu Mar 25 23:01:08 2004
+++ Products/Ape/component.xml	Thu Mar 25 23:59:38 2004
@@ -2,11 +2,10 @@
 <!-- Ape storage and database ZConfig section setup
-To use this, add the following to zope.conf:
+To connect to the filesystem, add the following to zope.conf:
 %import Products.Ape
 <ape-db fs>
     mapper-variation filesystem
@@ -19,9 +18,10 @@
-Or for a PostgreSQL connection:
+For a PostgreSQL connection (requires the psycopg module):
+%import Products.Ape
 <ape-db sql>
     mapper-variation sql
@@ -35,9 +35,10 @@
-Or for a MySQL connection:
+For a MySQL connection (requires the MySQLdb module):
+%import Products.Ape
 <ape-db sql>
     mapper-variation sql

=== Products/Ape/dbtab.conf 1.5 => 1.6 ===
--- Products/Ape/dbtab.conf:1.5	Sat Mar 20 01:34:21 2004
+++ Products/Ape/dbtab.conf	Thu Mar 25 23:59:38 2004
@@ -1,4 +1,4 @@
-# A sample dbtab.conf for getting started with Ape.
+# A sample dbtab.conf to use with Zope 2.6.
 [Storage: Main]

=== Products/Ape/version.txt 1.6 => 1.7 ===
--- Products/Ape/version.txt:1.6	Mon Aug 18 11:03:01 2003
+++ Products/Ape/version.txt	Thu Mar 25 23:59:38 2004
@@ -1 +1 @@

More information about the Zope-CVS mailing list