[Checkins] SVN: zope.kgs/trunk/ - Fix documentation in all scripts, fixing missing imports and incorrect

Stephan Richter srichter at cosmos.phy.tufts.edu
Thu Jan 29 21:09:09 EST 2009


Log message for revision 95531:
  - Fix documentation in all scripts, fixing missing imports and incorrect
    wording.
  
  - The package should depend on `python-dateutl` and not `datetutil`, since the
    latter is not available in PyPI anymore.
  

Changed:
  U   zope.kgs/trunk/CHANGES.txt
  U   zope.kgs/trunk/setup.py
  U   zope.kgs/trunk/src/zope/kgs/buildout.py
  U   zope.kgs/trunk/src/zope/kgs/change.py
  U   zope.kgs/trunk/src/zope/kgs/latest.py
  U   zope.kgs/trunk/src/zope/kgs/link.py
  U   zope.kgs/trunk/src/zope/kgs/ppix.py
  U   zope.kgs/trunk/src/zope/kgs/site.py
  U   zope.kgs/trunk/src/zope/kgs/version.py

-=-
Modified: zope.kgs/trunk/CHANGES.txt
===================================================================
--- zope.kgs/trunk/CHANGES.txt	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/CHANGES.txt	2009-01-30 02:09:09 UTC (rev 95531)
@@ -2,6 +2,15 @@
 CHANGES
 =======
 
+1.0.1 (2009-01-29)
+------------------
+
+- Fix documentation in all scripts, fixing missing imports and incorrect
+  wording.
+
+- The package should depend on `python-dateutl` and not `datetutil`, since the
+  latter is not available in PyPI anymore.
+
 1.0.0 (2009-01-29)
 ------------------
 

Modified: zope.kgs/trunk/setup.py
===================================================================
--- zope.kgs/trunk/setup.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/setup.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -19,7 +19,7 @@
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
 setup(name='zope.kgs',
-      version = '1.1.0dev',
+      version = '1.0.1',
       author='Zope Corporation and Contributors',
       author_email='zope-dev at zope.org',
       description='Known-Good-Set (KGS) Support',
@@ -49,7 +49,7 @@
           test=['zope.testing'],
           ),
       install_requires=[
-          'dateutil',
+          'python-dateutil',
           'docutils',
           'lxml',
           'setuptools',

Modified: zope.kgs/trunk/src/zope/kgs/buildout.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/buildout.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/buildout.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -13,7 +13,7 @@
 ##############################################################################
 """Generate a ``buildout.cfg`` file from the controlled list of packages.
 
-Usage: generate-buildout package-cfg-path [output-cfg-path]
+Usage: %s package-cfg-path [output-cfg-path]
 
 * ``package-cfg-path``
 
@@ -27,6 +27,7 @@
 
 """
 import os
+import sys
 
 from zope.kgs import kgs
 
@@ -59,7 +60,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1:
-        print __file__.__doc__
+        print __doc__ %sys.argv[0]
         sys.exit(1)
 
     packageConfigPath = os.path.abspath(args[0])

Modified: zope.kgs/trunk/src/zope/kgs/change.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/change.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/change.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -178,7 +178,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1 or args[0] in ('-h', '--help'):
-        print __file__.__doc__ % sys.argv[0]
+        print __doc__ % sys.argv[0]
         sys.exit(1)
 
     logger.setLevel(1)

Modified: zope.kgs/trunk/src/zope/kgs/latest.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/latest.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/latest.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -34,6 +34,7 @@
 import os
 import pkg_resources
 import re
+import sys
 import urllib
 import urllib2
 import zope.kgs.kgs
@@ -88,7 +89,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1 or args[0] in ('-h', '--help'):
-        print __file__.__doc__ % sys.argv[0]
+        print __doc__ % sys.argv[0]
         sys.exit(1)
 
     minorOnly = False

Modified: zope.kgs/trunk/src/zope/kgs/link.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/link.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/link.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -27,6 +27,7 @@
   name 'links.html'.
 """
 import os
+import sys
 import xmlrpclib
 import zope.kgs.kgs
 
@@ -66,7 +67,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1:
-        print __file__.__doc__ % sys.argv[0]
+        print __doc__ % sys.argv[0]
         sys.exit(1)
 
     packageConfigPath = os.path.abspath(args[0])

Modified: zope.kgs/trunk/src/zope/kgs/ppix.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/ppix.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/ppix.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -14,7 +14,7 @@
 """Generate a 'Links' HTML page that can be used as a `find-links` entry in
 setuptools.
 
-Usage: %s [-i] package-cfg-path [output-links-path]
+Usage: %s [-i] package-cfg-path [output-index-path]
 
 * -i
 
@@ -25,13 +25,14 @@
 
   This is the path to the controlled packages configuration file.
 
-* ``output-links-path``
+* ``output-index-path``
 
-  The path of the file under which the generated links file is stored. By
+  The path of the directory under which the generated index is stored. By
   default it is placed in the package configuration file's directory under the
-  name 'links.html'.
+  name 'index'.
 """
 import os
+import sys
 import urllib
 import urllib2
 import xmlrpclib
@@ -97,7 +98,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1:
-        print __file__.__doc__ % sys.argv[0]
+        print __doc__ % sys.argv[0]
         sys.exit(1)
 
     createIndex = False
@@ -108,9 +109,11 @@
     packageConfigPath = os.path.abspath(args[0])
 
     destDir = os.path.join(
-        os.path.dirname(packageConfigPath), 'links.html')
+        os.path.dirname(packageConfigPath), 'index')
     if len(args) == 2:
         destDir = args[1]
+    if not os.path.exists(destDir):
+        os.mkdir(destDir)
 
     generatePackagePages(packageConfigPath, destDir)
 

Modified: zope.kgs/trunk/src/zope/kgs/site.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/site.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/site.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -11,16 +11,7 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Generates a full KGS site with all bells and whistles.
-
-Usage: %s site-dir
-
-* ``site-dir``
-
-  The path to the directory where a ``controlled-packages.cfg`` file is
-  located to generate the site. The generated site is in that directory as
-  well.
-"""
+"""Generates a full KGS site with all bells and whistles."""
 import datetime
 import docutils.core
 import logging

Modified: zope.kgs/trunk/src/zope/kgs/version.py
===================================================================
--- zope.kgs/trunk/src/zope/kgs/version.py	2009-01-29 23:27:22 UTC (rev 95530)
+++ zope.kgs/trunk/src/zope/kgs/version.py	2009-01-30 02:09:09 UTC (rev 95531)
@@ -14,10 +14,8 @@
 """Generate a ``latest-versions.cfg`` file from the controlled list of
 packages.
 
-This file can
+Usage: %s package-cfg-path [output-cfg-path]
 
-Usage: generate-buildout package-cfg-path [output-cfg-path]
-
 * ``package-cfg-path``
 
   This is the path to the controlled packages configuration file.
@@ -30,6 +28,7 @@
 
 """
 import os
+import sys
 
 from zope.kgs import buildout, kgs
 
@@ -49,7 +48,7 @@
         args = sys.argv[1:]
 
     if len(args) < 1:
-        print __file__.__doc__
+        print __doc__ %sys.argv[0]
         sys.exit(1)
 
     packageConfigPath = os.path.abspath(args[0])



More information about the Checkins mailing list