[Checkins] SVN: zope.app.apidoc/trunk/ - Improved package meta-data.

Stephan Richter srichter at cosmos.phy.tufts.edu
Wed Oct 10 22:52:31 EDT 2007


Log message for revision 80812:
  - Improved package meta-data.
  
  - Fixed the code to at least gracefully ignore unzipped eggs. Eventually we
    want to handle eggs well.
  
  

Changed:
  A   zope.app.apidoc/trunk/CHANGES.txt
  U   zope.app.apidoc/trunk/README.txt
  U   zope.app.apidoc/trunk/buildout.cfg
  D   zope.app.apidoc/trunk/setup.cfg
  U   zope.app.apidoc/trunk/setup.py
  D   zope.app.apidoc/trunk/src/zope/app/apidoc/MAINTAINER.txt
  U   zope.app.apidoc/trunk/src/zope/app/apidoc/codemodule/module.py
  D   zope.app.apidoc/trunk/src/zope/app/apidoc/version.txt
  U   zope.app.apidoc/trunk/src/zope/app/apidoc/zcmlmodule/ftests.py

-=-
Added: zope.app.apidoc/trunk/CHANGES.txt
===================================================================
--- zope.app.apidoc/trunk/CHANGES.txt	                        (rev 0)
+++ zope.app.apidoc/trunk/CHANGES.txt	2007-10-11 02:52:30 UTC (rev 80812)
@@ -0,0 +1,17 @@
+=======
+CHANGES
+=======
+
+3.4.0 (2007-10-10)
+------------------
+
+- Improved package meta-data.
+
+- Fixed the code to at least gracefully ignore unzipped eggs. Eventually we
+  want to handle eggs well.
+
+
+3.4.0a1 (2007-??-??)
+--------------------
+
+- Initial release independent of the main Zope tree.


Property changes on: zope.app.apidoc/trunk/CHANGES.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: zope.app.apidoc/trunk/README.txt
===================================================================
--- zope.app.apidoc/trunk/README.txt	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/README.txt	2007-10-11 02:52:30 UTC (rev 80812)
@@ -1,36 +1,7 @@
-zope.app.apidoc Package Readme
-==============================
-
-Overview
---------
-
 This Zope 3 package provides fully dynamic API documentation of Zope 3 and
 registered add-on components. The package is very extensible and can be easily
 extended by implementing new modules.
 
-Changes
--------
+The static version of the full Zope tree is available at:
 
-See CHANGES.txt.
-
-Installation
-------------
-
-See INSTALL.txt.
-
-
-Developer Resources
--------------------
-
-- Subversion browser:
-
-  http://svn.zope.org/zope.app.apidoc/
-
-- Read-only Subversion checkout:
-
-  $ svn co svn://svn.zope.org/repos/main/zope.app.apidoc/trunk
-
-- Writable Subversion checkout:
-
-  $ svn co svn+ssh://userid@svn.zope.org/repos/main/zope.app.apidoc/trunk
-
+http://apidoc.zope.org

Modified: zope.app.apidoc/trunk/buildout.cfg
===================================================================
--- zope.app.apidoc/trunk/buildout.cfg	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/buildout.cfg	2007-10-11 02:52:30 UTC (rev 80812)
@@ -1,7 +1,6 @@
 [buildout]
 develop = .
 parts = test static-apidoc
-find-links = http://download.zope.org/distribution/
 
 [test]
 recipe = zc.recipe.testrunner
@@ -10,4 +9,4 @@
 
 [static-apidoc]
 recipe = zc.recipe.egg
-eggs = zope.app.apidoc
\ No newline at end of file
+eggs = zope.app.apidoc

Deleted: zope.app.apidoc/trunk/setup.cfg
===================================================================
--- zope.app.apidoc/trunk/setup.cfg	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/setup.cfg	2007-10-11 02:52:30 UTC (rev 80812)
@@ -1,2 +0,0 @@
-[egg_info]
-tag_svn_revision = 1
\ No newline at end of file

Modified: zope.app.apidoc/trunk/setup.py
===================================================================
--- zope.app.apidoc/trunk/setup.py	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/setup.py	2007-10-11 02:52:30 UTC (rev 80812)
@@ -15,61 +15,91 @@
 
 $Id$
 """
-
 import os
-
 from setuptools import setup, find_packages
 
-setup(name = 'zope.app.apidoc',
-      version = '3.4.0b1',
-      url = 'http://svn.zope.org/zope.app.apidoc',
-      license = 'ZPL 2.1',
-      description = 'Zope apidoc',
-      author = 'Zope Corporation and Contributors',
-      author_email = 'zope3-dev at zope.org',
-      long_description = "This Zope 3 package provides fully dynamic"
-                         "API documentation of Zope 3 and registered"
-                         "add-on components.",
+def read(*rnames):
+    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
-      packages = find_packages('src'),
-      package_dir = {'': 'src'},
-
-      namespace_packages = ['zope', 'zope.app'],
-      tests_require = ['zope.testing'],
-      install_requires = ['setuptools',
-                          'zope.annotation',
-                          'zope.app.appsetup',
-                          'zope.app.basicskin',
-                          'zope.app.component',
-                          'zope.app.container',
-                          'zope.app.onlinehelp',
-                          'zope.app.preference',
-                          'zope.app.publisher',
-                          'zope.app.renderer',
-                          'zope.app.skins',
-                          'zope.app.testing',
-                          'zope.app.tree',
-                          'zope.cachedescriptors',
-                          'zope.component',
-                          'zope.configuration',
-                          'zope.deprecation',
-                          'zope.i18n',
-                          'zope.interface',
-                          'zope.location',
-                          'zope.proxy',
-                          'zope.publisher',
-                          'zope.schema',
-                          'zope.security',
-                          'zope.testbrowser',
-                          'zope.testing',
-                          'zope.traversing',
-                          ],
-      extras_require = dict(test=['zope.app.testing',
-                                  'zope.app.securitypolicy',
-                                  'zope.app.zcmlfiles'],
-                            static=['mechanize'],
-                            ),
-      include_package_data = True,
+setup(
+    name = 'zope.app.apidoc',
+    version = '3.4.0',
+    author = 'Zope Corporation and Contributors',
+    author_email = 'zope3-dev at zope.org',
+    description = 'API Documentation and Component Inspection for Zope 3',
+    long_description=(
+        read('README.txt')
+        + '\n\n' +
+        'Detailed Documentation\n' +
+        '**********************\n\n'
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'README.txt')
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'component.txt')
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'interface.txt')
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'presentation.txt')
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'utilities.txt')
+        + '\n\n' +
+        read('src', 'zope', 'app', 'apidoc', 'classregistry.txt')
+        + '\n\n' +
+        read('CHANGES.txt')
+        ),
+    license = "ZPL 2.1",
+    keywords = "zope3 api documentation",
+    classifiers = [
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Zope Public License',
+        'Programming Language :: Python',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Topic :: Internet :: WWW/HTTP',
+        'Framework :: Zope3'],
+    url = 'http://cheeseshop.python.org/pypi/zope.app.apidoc',
+    packages = find_packages('src'),
+    include_package_data = True,
+    package_dir = {'':'src'},
+    namespace_packages = ['zope', 'zope.app'],
+    tests_require = ['zope.testing'],
+    install_requires = [
+        'setuptools',
+        'zope.annotation',
+        'zope.app.appsetup',
+        'zope.app.basicskin',
+        'zope.app.component',
+        'zope.app.container',
+        'zope.app.onlinehelp',
+        'zope.app.preference',
+        'zope.app.publisher',
+        'zope.app.renderer',
+        'zope.app.skins',
+        'zope.app.testing',
+        'zope.app.tree',
+        'zope.cachedescriptors',
+        'zope.component',
+        'zope.configuration',
+        'zope.deprecation',
+        'zope.i18n',
+        'zope.interface',
+        'zope.location',
+        'zope.proxy',
+        'zope.publisher',
+        'zope.schema',
+        'zope.security',
+        'zope.testbrowser',
+        'zope.testing',
+        'zope.traversing',
+        ],
+      extras_require = dict(
+          test=['zope.app.testing',
+                'zope.app.securitypolicy',
+                'zope.app.zcmlfiles'],
+          static=['mechanize'],
+          ),
       entry_points = """
         [console_scripts]
         static-apidoc = zope.app.apidoc.static:main

Deleted: zope.app.apidoc/trunk/src/zope/app/apidoc/MAINTAINER.txt
===================================================================
--- zope.app.apidoc/trunk/src/zope/app/apidoc/MAINTAINER.txt	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/src/zope/app/apidoc/MAINTAINER.txt	2007-10-11 02:52:30 UTC (rev 80812)
@@ -1,5 +0,0 @@
-Stephan Richter
-
-  Email: stephan.richter at tufts.edu
-
-  IRC nick: srichter
\ No newline at end of file

Modified: zope.app.apidoc/trunk/src/zope/app/apidoc/codemodule/module.py
===================================================================
--- zope.app.apidoc/trunk/src/zope/app/apidoc/codemodule/module.py	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/src/zope/app/apidoc/codemodule/module.py	2007-10-11 02:52:30 UTC (rev 80812)
@@ -34,9 +34,6 @@
 from zope.app.apidoc.codemodule.text import TextFile
 from zope.app.apidoc.codemodule.zcml import ZCMLFile
 
-# XXX This should be imported somewhere?
-import zope.app.zcmlfiles
-
 # Ignore these files, since they are not necessary or cannot be imported
 # correctly.
 IGNORE_FILES = ('tests', 'tests.py', 'ftests', 'ftests.py', 'CVS', 'gadfly',
@@ -65,6 +62,11 @@
                 self._module.__file__.endswith('__init__.pyo')):
             self._package = True
             for dir in self._module.__path__:
+                # TODO: If we are dealing with eggs, we will not have a
+                # directory right away. For now we just ignore zipped eggs;
+                # later we want to unzip it.
+                if not os.path.isdir(dir):
+                    continue
                 for file in os.listdir(dir):
                     if file in IGNORE_FILES or file in self._children:
                         continue

Deleted: zope.app.apidoc/trunk/src/zope/app/apidoc/version.txt
===================================================================
--- zope.app.apidoc/trunk/src/zope/app/apidoc/version.txt	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/src/zope/app/apidoc/version.txt	2007-10-11 02:52:30 UTC (rev 80812)
@@ -1 +0,0 @@
-apidoc 0.2

Modified: zope.app.apidoc/trunk/src/zope/app/apidoc/zcmlmodule/ftests.py
===================================================================
--- zope.app.apidoc/trunk/src/zope/app/apidoc/zcmlmodule/ftests.py	2007-10-10 23:19:11 UTC (rev 80811)
+++ zope.app.apidoc/trunk/src/zope/app/apidoc/zcmlmodule/ftests.py	2007-10-11 02:52:30 UTC (rev 80812)
@@ -24,7 +24,7 @@
 
     def testMenu(self):
         response = self.publish(
-            '/++apidoc++/ZCML/menu.html', 
+            '/++apidoc++/ZCML/menu.html',
             basic='mgr:mgrpw')
         self.assertEqual(response.getStatus(), 200)
         body = response.getBody()



More information about the Checkins mailing list