Merge 4333aff into 82933aa

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+source = src
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if __name__ == '__main__':

.gitignore

@@ -0,0 +1,13 @@
+bin/
+eggs/
+develop-eggs/
+parts/
+.installed.cfg
+*.py[co]
+__pycache__/
+build/
+dist/
+*.egg-info/
+.tox/
+.coverage
+htmlcov/

.travis.yml

@@ -0,0 +1,26 @@
+language: python
+sudo: false
+python:
+  - 2.7
+  - 3.4
+  - 3.5
+  - 3.6
+  - pypy-5.4.1
+script:
+  - coverage run -m zope.testrunner --test-path=src  --auto-color --auto-progress
+
+after_success:
+  - coveralls
+notifications:
+  email: false
+
+install:
+  - pip install -U pip setuptools
+  - pip install -U coveralls coverage
+  - pip install -U -e ".[test]"
+
+
+cache: pip
+
+before_cache:
+  - rm -f $HOME/.cache/pip/log/debug.log

CHANGES.rst

@@ -0,0 +1,66 @@
+=========
+ CHANGES
+=========
+
+4.0.0 (unreleased)
+==================
+
+- Add support for Python 3.4, 3.5, 3.6 and PyPy.
+
+- Change ZODB dependency to persistent.
+
+- Drop test dependency on ``zope.app.testing``,
+  ``zope.app.zcmlifiles`` and ``zope.app.apidoc``, among others.
+
+3.5.2 (2010-01-08)
+==================
+
+- Fix tests using a newer zope.publisher that requires zope.login.
+
+3.5.1 (2009-03-21)
+==================
+
+- Use ``zope.site`` instead of ``zope.app.folder``.
+
+3.5.0 (2009-02-01)
+==================
+
+- Removed ``OnlineHelpTopicFactory``, ``simple`` and
+  ``SimpleViewClass``. All of them where using old deprecated and
+  removed Zope3 imports. None of them where used and tested.
+
+- Use ``zope.container`` instead of ``zope.app.container``.
+
+- Removed use of ``zope.app.zapi``.
+
+3.4.1 (2007-10-25)
+==================
+
+- Package meta-data update.
+
+
+3.4.0 (2007-10-23)
+==================
+
+- Initial release independent of the main Zope tree.
+
+Older
+=====
+
+
+Make the onlinehelp utility more component oriented.
+
+- Use registred page/view instead of ViewPageTemplate for rendering topic tree
+  This way we can use/register own templates for tree layout.
+
+- Add page template based topic for rendering topics which has to
+  call other zope3 resources like javascripts and css styles sheets etc.
+  This resources can be rendered in the header area of the onlinehelp_macros.
+
+- Enhance the API of topics and simplyfie the view part.
+
+- Implemented getSubTopics() method on topics. This way we can sublist topics.
+
+- Remove unused onlinehelp code in rotterdam template.pt
+
+- Add type to directive, this supports registration of README.txt as 'rest' topics

MANIFEST.in

@@ -0,0 +1,20 @@
+include *.py
+include *.txt
+include *.rst
+include buildout.cfg
+include .travis.yml
+include .coveragerc
+include tox.ini
+
+recursive-include src *.gif
+recursive-include src *.pt
+recursive-include src *.rst
+recursive-include src *.zcml
+recursive-include src *.stx
+recursive-include src *.txt
+recursive-include src *.png
+recursive-include src *.css
+recursive-include src *.cfg
+recursive-include src *.js
+recursive-include src *.html
+recursive-include src *.xml

setup.cfg

@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal = 1

setup.py

@@ -18,69 +18,96 @@
 ##############################################################################
 """Setup for zope.app.onlinehelp package
 
-$Id$
 """
 import os
 from setuptools import setup, find_packages
 
 def read(*rnames):
-    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+    with open(os.path.join(os.path.dirname(__file__), *rnames)) as f:
+        return f.read()
 
-setup(name = 'zope.app.onlinehelp',
-      version = '3.5.3dev',
+setup(name='zope.app.onlinehelp',
+      version='4.0.0.dev0',
       author='Zope Corporation and Contributors',
       author_email='zope-dev@zope.org',
       description='Framework for Context-Sensitive Help Pages',
       long_description=(
-          read('README.txt')
+          read('README.rst')
           + '\n\n' +
-          read('CHANGES.txt')
+          read('CHANGES.rst')
           ),
-      keywords = "zope3 online help",
-      classifiers = [
+      keywords="zope3 online help",
+      classifiers=[
           'Development Status :: 5 - Production/Stable',
           'Environment :: Web Environment',
           'Intended Audience :: Developers',
           'License :: OSI Approved :: Zope Public License',
           'Programming Language :: Python',
+          'Programming Language :: Python :: 2',
+          'Programming Language :: Python :: 2.7',
+          'Programming Language :: Python :: 3',
+          'Programming Language :: Python :: 3.4',
+          'Programming Language :: Python :: 3.5',
+          'Programming Language :: Python :: 3.6',
+          'Programming Language :: Python :: Implementation :: CPython',
+          'Programming Language :: Python :: Implementation :: PyPy',
           'Natural Language :: English',
           'Operating System :: OS Independent',
           'Topic :: Internet :: WWW/HTTP',
-          'Framework :: Zope3'],
-      url='http://pypi.python.org/pypi/zope.app.onlinehelp',
+          'Framework :: Zope3',
+      ],
+      url='http://github.com/zopefoundation/zope.app.onlinehelp',
       license='ZPL 2.1',
       packages=find_packages('src'),
-      package_dir = {'': 'src'},
+      package_dir={'': 'src'},
       namespace_packages=['zope', 'zope.app'],
-      install_requires = ['setuptools',
-                          'ZODB3',
-                          'zope.app.component',
-                          'zope.app.file',
-                          'zope.app.pagetemplate',
-                          'zope.app.publication',
-                          'zope.app.security',
-                          'zope.app.testing',
-                          'zope.component',
-                          'zope.configuration',
-                          'zope.container',
-                          'zope.contenttype',
-                          'zope.i18n',
-                          'zope.interface',
-                          'zope.location',
-                          'zope.publisher >= 3.12',
-                          'zope.schema',
-                          'zope.security',
-                          'zope.testing',
-                          'zope.traversing',
-                          ],
-      extras_require = dict(test=['zope.app.testing',
-                                  'zope.app.preference',
-                                  'zope.app.apidoc',
-                                  'zope.site',
-                                  'zope.login',
-                                  'zope.app.securitypolicy',
-                                  'zope.app.zcmlfiles',
-                                  'zope.securitypolicy']),
-      include_package_data = True,
-      zip_safe = False,
-      )
+      install_requires=[
+          'persistent',
+          'setuptools',
+          'zope.app.component',
+          'zope.app.file >= 4.0.0',
+          'zope.app.pagetemplate >= 4.0.0',
+          'zope.app.publication >= 4.2.1',
+          'zope.app.security >= 4.0.0',
+          'zope.component',
+          'zope.configuration',
+          'zope.container',
+          'zope.contenttype',
+          'zope.i18n',
+          'zope.interface',
+          'zope.location',
+          'zope.publisher >= 4.3.1',
+          'zope.schema',
+          # XXX: Really need 4.1.1 for downstream to work
+          # correctly. See https://github.com/zopefoundation/zope.security/pull/24
+          'zope.security >= 4.1.0',
+          'zope.testing',
+          'zope.traversing',
+      ],
+      extras_require={
+          'test': [
+              'webtest',
+              'zope.app.basicskin >= 4.0.0',
+              'zope.app.folder',
+              'zope.app.http',
+              'zope.app.principalannotation',
+              'zope.app.preference >= 4.0.0',
+              'zope.app.renderer >= 4.0.0',
+              'zope.app.rotterdam >= 4.0.0',
+              'zope.app.securitypolicy',
+              'zope.app.wsgi',
+              'zope.annotation',
+              'zope.copypastemove',
+              'zope.configuration',
+              'zope.formlib',
+              'zope.login',
+              'zope.principalannotation',
+              'zope.securitypolicy',
+              'zope.site',
+              'zope.testing',
+              'zope.testrunner',
+          ],
+      },
+      include_package_data=True,
+      zip_safe=False,
+)

src/zope/__init__.py

@@ -1,7 +1 @@
-# this is a namespace package
-try:
-    import pkg_resources
-    pkg_resources.declare_namespace(__name__)
-except ImportError:
-    import pkgutil
-    __path__ = pkgutil.extend_path(__path__, __name__)
+__import__('pkg_resources').declare_namespace(__name__) # pragma: no cover

src/zope/app/__init__.py

@@ -1,7 +1 @@
-# this is a namespace package
-try:
-    import pkg_resources
-    pkg_resources.declare_namespace(__name__)
-except ImportError:
-    import pkgutil
-    __path__ = pkgutil.extend_path(__path__, __name__)
+__import__('pkg_resources').declare_namespace(__name__) # pragma: no cover

src/zope/app/onlinehelp/__init__.py

@@ -15,7 +15,6 @@
 
 Create the global `OnlineHelp` instance.
 
-$Id$
 """
 __docformat__ = 'restructuredtext'
 
@@ -26,8 +25,8 @@
 from zope.interface import providedBy
 from zope.testing import cleanup
 
-from interfaces import IOnlineHelpTopic
-from onlinehelp import OnlineHelp
+from zope.app.onlinehelp.interfaces import IOnlineHelpTopic
+from zope.app.onlinehelp.onlinehelp import OnlineHelp
 
 
 # Global Online Help Instance
@@ -61,9 +60,9 @@ def getTopicFor(obj, view=None):
     Prepare the tests:
 
     >>> import os
-    >>> from tests.test_onlinehelp import testdir
-    >>> from tests.test_onlinehelp import I1, Dummy1, Dummy2
-    >>> from zope.app.testing import ztapi
+    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+    >>> from zope.app.onlinehelp.tests.test_onlinehelp import I1, Dummy1, Dummy2
+    >>> from zope.app.onlinehelp import tests as ztapi
     >>> from zope.component.interfaces import IFactory
     >>> from zope.component.factory import Factory
     >>> from zope.app.onlinehelp.onlinehelptopic import OnlineHelpTopic