ztfy/utils/docs/README.txt
changeset 0 712d20d2751e
child 45 6b70bf7c698f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ztfy/utils/docs/README.txt	Sat Jan 10 00:35:35 2009 +0100
@@ -0,0 +1,24 @@
+==================
+ztfy.utils package
+==================
+
+.. contents::
+
+What is ztfy.utils ?
+====================
+
+ztfy.utils is a set of classes and functions which can be used to handle many small operations.
+
+Internal sub-packages include :
+ - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime
+ - request : get current request, get request annotations, get and set request data via annotations
+ - security : get unproxied value of a given object ; can be applied to lists or dicts
+ - timezone : convert datetime to a given timezone
+ - traversing : get object parents until a given interface is implemented
+ - unicode : convert any text to unicode for easy storage
+ 
+
+How to use ztfy.utils ?
+=======================
+
+A set of ztfy.utils usage are given as doctests in ztfy/utils/doctests/README.txt