summaryrefslogtreecommitdiffstats
path: root/python/python-transaction/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python-transaction/README')
-rw-r--r--python/python-transaction/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/python/python-transaction/README b/python/python-transaction/README
new file mode 100644
index 0000000000..f80fdb9017
--- /dev/null
+++ b/python/python-transaction/README
@@ -0,0 +1,8 @@
+This package contains a generic transaction implementation for Python. It
+is mainly used by the ZODB, though.
+
+Note that the data manager API, transaction.interfaces.IDataManager, is
+syntactically simple, but semantically complex. The semantics were not
+easy to express in the interface. This could probably use more work. The
+semantics are presented in detail through examples of a sample data manager
+in transaction.tests.test_SampleDataManager.