[Zope-CVS] CVS: Products/Ape - CHANGES.txt:1.4 README.txt:1.3 dbtab.conf:1.3 version.txt:1.3

[Shane Hathaway]

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

Modified Files:
	CHANGES.txt README.txt dbtab.conf version.txt 
Log Message:
Updated documentation in preparation for release

=== Products/Ape/CHANGES.txt 1.3 => 1.4 ===
--- Products/Ape/CHANGES.txt:1.3	Sat Mar 29 17:31:29 2003
+++ Products/Ape/CHANGES.txt	Mon Apr 21 13:29:37 2003
@@ -1,16 +1,22 @@
 
-Next release (0.6)
+Version 0.6
 
-  - Renamed to "Ape", short for Adaptable PErsistence.  Put most of the
-    code in apelib, a new top-level package usable outside Zope and
-    ZODB.
-
-  - Changed naming conventions to fit Zope 3.  Modules have lowercase
-    names and usually define more than one class.  I'm not sure it's
-    better this way, but it definitely looks more compact.  As a side
-    effect, this led to a 30% reduction in lines of code, now down to
-    7200.  If Guido is right and one person can only deal with 10,000
-    lines of code at a time, we're safe again.
+  - Renamed to "Ape", short for Adaptable PErsistence.  Put most of
+    the code in apelib, a new top-level package usable outside Zope and
+    ZODB.  The top-level package is located inside the Ape product, but
+    the Ape product imports the package without requiring PYTHONPATH
+    adjustments.
+
+  - Changed naming conventions to fit Zope 3.  Modules now have
+    lowercase names and usually define more than one class.  The new
+    layout is more compact.  As a side benefit, this led to a 30%
+    reduction in lines of code, falling to 7200.  If Guido is right and
+    one person can only deal with 10,000 lines of code at a time, we're
+    safe again.
+
+  - Added MySQL support, tested with MySQL-Max 4.0.11.  A recent
+    version of the Python MySQLdb wrapper and transaction support in
+    MySQL are required.
 
   - Renamed some classes and interfaces:
 
@@ -21,7 +27,7 @@
           IObjectMapper to IMapper
           IAspectSerializer to ISerializer
 
-  - Minor enhancements to filename extension processing.
+  - Enhanced filename extension processing.
 
   - Fixed loading of ZClass instances.
 


=== Products/Ape/README.txt 1.2 => 1.3 ===
--- Products/Ape/README.txt:1.2	Sat Mar 15 20:13:45 2003
+++ Products/Ape/README.txt	Mon Apr 21 13:29:37 2003
@@ -1,8 +1,9 @@
 
-* Ape Quick Start *
+Ape README
 
-The following steps help you get started with Ape quickly.
-See doc.txt for more information.
+
+Assuming you already have Zope set up and working, follow these steps
+to get started with Ape and DBTab.
 
 1. Check your Zope version.  You need at least Zope 2.6.1.
 
@@ -18,10 +19,11 @@
   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 setup, adjust the path to custom_zodb.py accordingly.
+INSTANCE_HOME, custom_zodb.py belongs in your INSTANCE_HOME.
 
-4. Copy the sample dbtab.conf from the Ape product to your
-INSTANCE_HOME or the root of your Zope site.
+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
+INSTANCE_HOME.
 
 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.
@@ -40,4 +42,62 @@
 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
+dbtab.conf:
+
+
+[Storage: PostgreSQL]
+type=apelib.zodb3.storage.ApeStorage
+factory=apelib.zope2.sqlmapper.createMapper
+module_name=psycopg
+params=
+
+[Database: PostgreSQL]
+class=apelib.zodb3.db.ApeDB
+mount_paths=/pg
+
+
+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]
+type=apelib.zodb3.storage.ApeStorage
+factory=apelib.zope2.sqlmapper.createMapper
+module_name=MySQLdb
+kwparams=db:ape
+
+[Database: MySQL]
+class=apelib.zodb3.db.ApeDB
+mount_paths=/my
+
+
+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.
+
+
+Tutorial
+
+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:
+
+http://cvs.zope.org/Products/Ape/doc/tutorial_slides.sxi?rev=HEAD&content-type=application/octet-stream
 


=== Products/Ape/dbtab.conf 1.2 => 1.3 ===
--- Products/Ape/dbtab.conf:1.2	Sat Mar 15 20:13:45 2003
+++ Products/Ape/dbtab.conf	Mon Apr 21 13:29:37 2003
@@ -17,5 +17,5 @@
 class=apelib.zodb3.db.ApeDB
 cache_size=0
 mount_paths=/fs
-auto_create=1
+container_class=OFS.Folder.Folder
 


=== Products/Ape/version.txt 1.2 => 1.3 ===
--- Products/Ape/version.txt:1.2	Sat Mar 15 20:13:45 2003
+++ Products/Ape/version.txt	Mon Apr 21 13:29:37 2003
@@ -1 +1 @@
-Ape-0.6-unreleased
+Ape-0.6