[Checkins] SVN: z3c.layer.minimal/trunk/ Prop up meta data and documentation. Get ready for release.

Stephan Richter srichter at cosmos.phy.tufts.edu
Thu Jan 24 21:06:49 EST 2008


Log message for revision 83202:
  Prop up meta data and documentation. Get ready for release.
  

Changed:
  U   z3c.layer.minimal/trunk/CHANGES.txt
  U   z3c.layer.minimal/trunk/setup.py
  U   z3c.layer.minimal/trunk/src/z3c/layer/minimal/README.txt

-=-
Modified: z3c.layer.minimal/trunk/CHANGES.txt
===================================================================
--- z3c.layer.minimal/trunk/CHANGES.txt	2008-01-25 01:57:13 UTC (rev 83201)
+++ z3c.layer.minimal/trunk/CHANGES.txt	2008-01-25 02:06:49 UTC (rev 83202)
@@ -2,19 +2,20 @@
 CHANGES
 =======
 
-1.0.1dev (unreleased)
----------------------
+1.0.1 (2008-01-24)
+------------------
 
-- ...
+- Bug: Improved meta-data.
 
 
-1.0.0 (2007-01-21)
+1.0.0 (2008-01-21)
 ------------------
 
-- move z3c.layer.minimal package to it's own top level package
-  form zope.layer to z3c.layer.minimal
+- Restructure: Move ``z3c.layer.minimal`` package to it's own top level
+  package form ``zope.layer`` to ``z3c.layer.minimal``.
 
-- moved implementation from z3c.layer to z3c.layer.minimal
+- Restructure: Moved implementation from ``z3c.layer`` to
+  ``z3c.layer.minimal``
 
 
 0.2.3 (2007-11-07)
@@ -29,7 +30,7 @@
 0.2.2 (2007-10-31)
 ------------------
 
-- Fixed package meta-data.
+- Bug: Fixed package meta-data.
 
 - Bug: Fixed test failures due to depency updates.
 

Modified: z3c.layer.minimal/trunk/setup.py
===================================================================
--- z3c.layer.minimal/trunk/setup.py	2008-01-25 01:57:13 UTC (rev 83201)
+++ z3c.layer.minimal/trunk/setup.py	2008-01-25 02:06:49 UTC (rev 83202)
@@ -16,22 +16,28 @@
 
 $Id: setup.py 313 2007-05-22 15:33:41Z srichter $
 """
-
 import os
+import xml.sax.saxutils
 from setuptools import setup, find_packages
 
 def read(*rnames):
-    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+    text = open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+    return xml.sax.saxutils.escape(text)
 
 setup(
     name = 'z3c.layer.minimal',
-    version = '1.0.1dev',
+    version = '1.0.1',
     author='Zope Foundation and Contributors',
-    author_email = "zope3-dev at zope.org",
+    author_email = "zope-dev at zope.org",
     description = "Minimal layer setup for Zope3",
     long_description=(
         read('README.txt')
         + '\n\n' +
+        'Detailed Documentation\n'
+        '**********************'
+        + '\n\n' +
+        read('src', 'z3c', 'layer', 'minimal', 'README.txt')
+        + '\n\n' +
         read('CHANGES.txt')
         ),
     keywords = "z3c minimal layer zope zope3",
@@ -45,7 +51,7 @@
         'Operating System :: OS Independent',
         'Topic :: Internet :: WWW/HTTP',
         'Framework :: Zope3'],
-    url='http://cheeseshop.python.org/pypi/z3c.layer.minimal',
+    url='http://pypi.python.org/pypi/z3c.layer.minimal',
     license='ZPL 2.1',
     packages = find_packages('src'),
     include_package_data = True,

Modified: z3c.layer.minimal/trunk/src/z3c/layer/minimal/README.txt
===================================================================
--- z3c.layer.minimal/trunk/src/z3c/layer/minimal/README.txt	2008-01-25 01:57:13 UTC (rev 83201)
+++ z3c.layer.minimal/trunk/src/z3c/layer/minimal/README.txt	2008-01-25 02:06:49 UTC (rev 83202)
@@ -1,39 +1,39 @@
-======
-README
-======
+================================
+Minimal Browser Layer for Zope 3
+================================
 
-This package contains the minimal layer. This layer supports a correct set of 
+This package contains the minimal layer. This layer supports a correct set of
 component registration and can be used for inheritation in custom skins.
 
 Right now the default implementation in Zope3 has different restriction in the
 traversal concept and use to much registration on the default layer.
 
 
-IMinimalBrowserLayer
---------------------
+``IMinimalBrowserLayer`` Interface
+----------------------------------
 
-The minimal layer is useful for build custom presentation skins without access 
-to ZMI menus like zmi_views etc. This means there is no menu item registred if 
-you use this layer.
+The minimal layer is useful for build custom presentation skins without access
+to ZMI menus like `zmi_views` etc. This means there is no menu item registred
+if you use this layer.
 
-This layer is NOT derived from IDefaultBrowserLayer. Therefore it provides 
-only a minimal set of the most important public views such as @@absolute_url. 
-The following packages are accounted:
+This layer is NOT derived from ``IDefaultBrowserLayer``. Therefore it provides
+only a minimal set of the most important public views such as
+``@@absolute_url``.  The following packages are accounted:
 
-- zope.app.http.exception
-- zope.app.publication
-- zope.app.publisher.browser
-- zope.app.traversing
-- zope.app.traversing.browser
+- ``zope.app.http.exception``
+- ``zope.app.publication``
+- ``zope.app.publisher.browser``
+- ``zope.app.traversing``
+- ``zope.app.traversing.browser``
 
 
 Testing
 -------
 
-For testing the IMinimalBrowserLayer we use the testing skin defined in the 
-tests package which uses the IMinimalBrowserLayer as the only base layer.
-This means, that our testing skin provides only the views defined in the 
-minimal package and it's testing views defined in tests.
+For testing the ``IMinimalBrowserLayer`` layer we use the testing skin defined
+in the tests package which uses the ``IMinimalBrowserLayer`` layer as the only
+base layer.  This means, that our testing skin provides only the views defined
+in the minimal package and it's testing views defined in tests.
 
 Login as manager first:
 
@@ -41,7 +41,7 @@
   >>> manager = Browser()
   >>> manager.addHeader('Authorization', 'Basic mgr:mgrpw')
 
-Check if we can access the page.html view which is registred in the 
+Check if we can access the page.html view which is registred in the
 ftesting.zcml file with our skin:
 
   >>> manager = Browser()
@@ -108,7 +108,7 @@
   <BLANKLINE>
   <BLANKLINE>
 
-And check the user error page which is a view registred for 
+And check the user error page which is a view registred for
 ``zope.exceptions.interfaces.IUserError`` exceptions:
 
   >>> manager.open(skinURL + '/@@usererror.html')
@@ -127,7 +127,7 @@
   <BLANKLINE>
   <BLANKLINE>
 
-And check error view registred for 
+And check error view registred for
 ``zope.interface.common.interfaces.IException``:
 
   >>> manager.open(skinURL + '/@@systemerror.html')
@@ -153,7 +153,7 @@
   <BLANKLINE>
   <BLANKLINE>
 
-And check the ``zope.security.interfaces.IUnauthorized`` view, use a new 
+And check the ``zope.security.interfaces.IUnauthorized`` view, use a new
 unregistred user (test browser) for this:
 
   >>> unauthorized = Browser()



More information about the Checkins mailing list