[Checkins] SVN: Product.ZSQLAlchemy/trunk/ doc update

[Andreas Jung]

Log message for revision 72293:
  doc update
  

Changed:
  U   Product.ZSQLAlchemy/trunk/README.txt
  U   Product.ZSQLAlchemy/trunk/ZSQLAlchemy.py
  U   Product.ZSQLAlchemy/trunk/__init__.py

-=-
Modified: Product.ZSQLAlchemy/trunk/README.txt
===================================================================
--- Product.ZSQLAlchemy/trunk/README.txt	2007-02-01 11:57:49 UTC (rev 72292)
+++ Product.ZSQLAlchemy/trunk/README.txt	2007-02-01 12:02:36 UTC (rev 72293)
@@ -4,3 +4,30 @@
 D-72070 Tuebingen, Germany
 
 ZSQLAlchemy is published under the Zope Public License 2.1 (ZPL 2.1)
+
+
+
+What is it:
+
+    - ZSQLAlchemy tries to provide a basic SQLAlchemy infrastructure to be used
+      with Zope applications. It basically acts like some kind of DA and cares
+      automatically about connection and transaction handling
+
+Limitation:
+
+    - currently only supports Postgres through the psycopg2 Python bindings
+      for Postgres
+
+
+
+Requirements:
+
+    - Zope 2.8
+
+    - sqlalchemy V 0.3.0 or higher
+
+    - psycopg2 2.0.5
+
+
+
+

Modified: Product.ZSQLAlchemy/trunk/ZSQLAlchemy.py
===================================================================
--- Product.ZSQLAlchemy/trunk/ZSQLAlchemy.py	2007-02-01 11:57:49 UTC (rev 72292)
+++ Product.ZSQLAlchemy/trunk/ZSQLAlchemy.py	2007-02-01 12:02:36 UTC (rev 72293)
@@ -1,15 +1,21 @@
+##########################################################################
+# ZSQLAlchemy
+#
+# (C) 2007, ZOPYX Ltd & Co. KG
+# D-72070 Tuebingen, Germany
+# www.zopyx.com, info at zopyx.com
+#
+# Written by Andreas Jung
+#
+# ZSQLAlchemy is published under the Zope Public License 2.1 (ZPL 2.1)
+##########################################################################
 
-"""
-ZSQLAlchemy
 
-$Id$
-"""
-
 from Globals import InitializeClass
-from Shared.DC.ZRDB.TM import TM
+from AccessControl import ClassSecurityInfo
 from OFS.SimpleItem import SimpleItem
-from AccessControl import ClassSecurityInfo
 from OFS.PropertyManager import PropertyManager
+from Shared.DC.ZRDB.TM import TM
 from Products.PageTemplates.PageTemplateFile import PageTemplateFile
 
 import sqlalchemy
@@ -19,6 +25,11 @@
 
 
 class SessionProxy(object, TM):
+    """ A session proxy that provides basic infrastructure for applications
+        working with SQLAlchemy. The proxy represents a SQLAlchemy session.
+        The proxy (and therefore the SQLAlchemy sesssion) participate in
+        the Zope 2 transaction handling.
+    """
 
     security = ClassSecurityInfo()
 
@@ -70,10 +81,10 @@
                      PropertyManager.manage_options    
 
     _properties=(
-                 {'id':'hostname', 'type':'string', 'mode':'wrd'},
-                 {'id':'username', 'type':'string', 'mode':'wrd'},
-                 {'id':'password', 'type':'string', 'mode':'wrd'},
-                 {'id':'database', 'type':'string', 'mode':'wrd'},
+                 {'id':'hostname', 'type':'string', 'mode':'wr'},
+                 {'id':'username', 'type':'string', 'mode':'wr'},
+                 {'id':'password', 'type':'string', 'mode':'wr'},
+                 {'id':'database', 'type':'string', 'mode':'wr'},
                  )
 
     security = ClassSecurityInfo()

Modified: Product.ZSQLAlchemy/trunk/__init__.py
===================================================================
--- Product.ZSQLAlchemy/trunk/__init__.py	2007-02-01 11:57:49 UTC (rev 72292)
+++ Product.ZSQLAlchemy/trunk/__init__.py	2007-02-01 12:02:36 UTC (rev 72293)
@@ -1,3 +1,14 @@
+##########################################################################
+# ZSQLAlchemy
+#
+# (C) 2007, ZOPYX Ltd & Co. KG
+# D-72070 Tuebingen, Germany
+# www.zopyx.com, info at zopyx.com
+#
+# Written by Andreas Jung
+#
+# ZSQLAlchemy is published under the Zope Public License 2.1 (ZPL 2.1)
+##########################################################################
 
 import os, sys