[CalendarServer-changes] [12524] twext/trunk/README.rst

[source_changes at macosforge.org]

Revision: 12524
          http://trac.calendarserver.org//changeset/12524
Author:   wsanchez at apple.com
Date:     2014-01-31 15:47:38 -0800 (Fri, 31 Jan 2014)
Log Message:
-----------
Document deps

Modified Paths:
--------------
    twext/trunk/README.rst

Modified: twext/trunk/README.rst
===================================================================
--- twext/trunk/README.rst	2014-01-31 23:40:04 UTC (rev 12523)
+++ twext/trunk/README.rst	2014-01-31 23:47:38 UTC (rev 12524)
@@ -24,10 +24,41 @@
 
 This library is can be built using the standard distutils mechanisms.
 
-It is also registered with the Python Package Index (PyPI) as ``twextpy`` for
-use with ``pip`` and ``easy_install``.
+It is also registered with the Python Package Index (PyPI) as ``twextpy`` 
+(the name ``twext`` is used by another module in PyPI) for use with ``pip`` and
+``easy_install``::
 
+  pip install twextpy
 
+This will build and install the ``twext`` module along with its base
+dependencies.  This library has a number of optional features which must be
+specified in order to download build and install their dependencies, for
+example::
+
+  pip install twextpy[DAL,Postgres]
+
+These features are:
+
+DAL
+  Enables use of the Database Abstraction Layer implemented in
+  ``twext.enterprise.dal``.
+
+LDAP
+  Enables support for the Lightweight Directory Access Protocol in
+  ``twext.who.ldap``.
+
+OpenDirectory
+  Enables support for the (Mac OS) OpenDirectory framework in
+  ``twext.who.opendirectory``.
+
+Oracle
+  Enables support for Oracle database connectivity in ``twext.enterprise`` and
+  Oracle syntax in ``twext.enterprise.dal``.
+
+Postgres
+  Enables support for Postgres database connectivity in ``twext.enterprise``.
+
+
 Development
 ===========
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20140312/0b365a0e/attachment.html>