- configure with zope.meta.config.config-package

.editorconfig

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+#
+# EditorConfig Configuration file, for more details see:
+# http://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]  # For All Files
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+# Max Line Length - a hard line wrap, should be disabled
+max_line_length = off
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{yml,zpt,pt,dtml,zcml}]
+# 2 space indentation
+indent_size = 2
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset

.github/workflows/tests.yml

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
 name: tests
 
 on:
@@ -5,37 +7,46 @@ on:
   pull_request:
   schedule:
     - cron: '0 12 * * 0'  # run once a week on Sunday
+  # Allow to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
   build:
     strategy:
+      # We want to see all failures:
       fail-fast: false
       matrix:
+        os:
+        - ubuntu
         config:
         # [Python version, tox env]
+        - ["3.9",   "lint"]
         - ["2.7",   "py27"]
+        - ["3.5",   "py35"]
+        - ["3.6",   "py36"]
+        - ["3.7",   "py37"]
+        - ["3.8",   "py38"]
+        - ["3.9",   "py39"]
+        - ["3.10",  "py310"]
+        - ["pypy-2.7", "pypy"]
+        - ["pypy-3.7", "pypy3"]
+        - ["3.9",   "docs"]
+        - ["3.9",   "coverage"]
         - ["2.7",   "py27-msgpack1"]
         - ["2.7",   "py27-zeo4"]
         - ["2.7",   "py27-zodbmaster"]
-        - ["3.6",   "py36"]
-        - ["3.7",   "py37"]
         - ["3.7",   "py37-msgpack1"]
         - ["3.7",   "py37-uvloop"]
         - ["3.7",   "py37-zodbmaster"]
-        - ["3.8",   "py38"]
         - ["3.8",   "py38-msgpack1"]
         - ["3.8",   "py38-uvloop"]
-        - ["3.9",   "py39"]
         - ["3.9",   "py39-msgpack1"]
         - ["3.9",   "py39-uvloop"]
-        - ["3.10",  "py310"]
         - ["3.10",  "py310-msgpack1"]
         - ["3.10",  "py310-uvloop"]
-        - ["pypy2", "pypy"]
-        - ["pypy3", "pypy3"]
-        - ["pypy3", "pypy3-msgpack1"]
+        - ["pypy-3.7", "pypy3-msgpack1"]
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}-latest
     name: ${{ matrix.config[1] }}
     steps:
     - uses: actions/checkout@v2

.gitignore

-.*.swp
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+*.dll
+*.egg-info/
+*.profraw
 *.pyc
-__pycache__
-*.egg-info
-.installed.cfg
-.tox
-bin
-default.profraw
-develop-eggs
-dist
-eggs
-parts
-pyvenv.cfg
-testing.log
-.dir-locals.el
-data.fs*
-ZEO_forker*.conf
+*.pyo
+*.so
+.coverage
+.coverage.*
 .eggs/
-doc/_build
+.installed.cfg
+.mr.developer.cfg
+.tox/
+.vscode/
+__pycache__/
+bin/
+build/
+coverage.xml
+develop-eggs/
+develop/
+dist/
+docs/_build
+eggs/
+etc/
 lib/
 lib64
+log/
+parts/
+pyvenv.cfg
+var/

.meta.toml

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+[meta]
+template = "pure-python"
+commit-id = "3b712f305ca8207e971c5bf81f2bdb5872489f2f"
+
+[python]
+with-windows = false
+with-pypy = true
+with-future-python = false
+with-legacy-python = true
+with-docs = true
+with-sphinx-doctests = false
+
+[tox]
+use-flake8 = false
+testenv-commands = [
+    "# Run unit tests first.",
+    "zope-testrunner -u --test-path=src {posargs:-vc}",
+    "# Only run functional tests if unit tests pass.",
+    "zope-testrunner -f --test-path=src {posargs:-vc}",
+    ]
+testenv-deps = [
+    "!zodbmaster: ZODB >= 4.2.0b1",
+    "zodbmaster: -e git+https://github.com/zopefoundation/ZODB.git@master#egg=ZODB",
+    "uvloop: uvloop",
+    ]
+testenv-setenv = [
+    "!py27-!pypy: PYTHONWARNINGS=ignore::ResourceWarning",
+    "msgpack1: ZEO_MSGPACK=1",
+    "zeo4: ZEO4_SERVER=1",
+    ]
+
+[coverage]
+fail-under = 53
+
+[manifest]
+additional-rules = [
+    "include *.py",
+    "include COPYING",
+    "include log.ini",
+    "recursive-include src *.csr",
+    "recursive-include src *.pem",
+    "recursive-include src *.rst",
+    "recursive-include src *.test",
+    "recursive-include src *.txt",
+    "recursive-include src *.xml",
+    ]
+
+[github-actions]
+additional-config = [
+    "- [\"2.7\",   \"py27-msgpack1\"]",
+    "- [\"2.7\",   \"py27-zeo4\"]",
+    "- [\"2.7\",   \"py27-zodbmaster\"]",
+    "- [\"3.7\",   \"py37-msgpack1\"]",
+    "- [\"3.7\",   \"py37-uvloop\"]",
+    "- [\"3.7\",   \"py37-zodbmaster\"]",
+    "- [\"3.8\",   \"py38-msgpack1\"]",
+    "- [\"3.8\",   \"py38-uvloop\"]",
+    "- [\"3.9\",   \"py39-msgpack1\"]",
+    "- [\"3.9\",   \"py39-uvloop\"]",
+    "- [\"3.10\",  \"py310-msgpack1\"]",
+    "- [\"3.10\",  \"py310-uvloop\"]",
+    "- [\"pypy-3.7\", \"pypy3-msgpack1\"]",
+    ]

CONTRIBUTING.md

+<!--
+Generated from:
+https://github.com/zopefoundation/meta/tree/master/config/pure-python
+--> 
+# Contributing to zopefoundation projects
+
+The projects under the zopefoundation GitHub organization are open source and
+welcome contributions in different forms:
+
+* bug reports
+* code improvements and bug fixes
+* documentation improvements
+* pull request reviews
+
+For any changes in the repository besides trivial typo fixes you are required
+to sign the contributor agreement. See
+https://www.zope.dev/developer/becoming-a-committer.html for details.
+
+Please visit our [Developer
+Guidelines](https://www.zope.dev/developer/guidelines.html) if you'd like to
+contribute code changes and our [guidelines for reporting
+bugs](https://www.zope.dev/developer/reporting-bugs.html) if you want to file a
+bug report.

MANIFEST.in

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+include *.md
 include *.rst
 include *.txt
-include *.py
 include buildout.cfg
 include tox.ini
-include COPYING
-include log.ini
 
-recursive-include src *
-recursive-include doc *.txt
-recursive-include doc *.py
-recursive-include doc *.rst
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
 
-global-exclude *.pyc
+recursive-include src *.py
+include *.py
+include COPYING
+include log.ini
+recursive-include src *.csr
+recursive-include src *.pem
+recursive-include src *.rst
+recursive-include src *.test
+recursive-include src *.txt
+recursive-include src *.xml

bootstrap.py

-##############################################################################
-#
-# Copyright (c) 2006 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""Bootstrap a buildout-based project
-
-Simply run this script in a directory containing a buildout.cfg.
-The script accepts buildout command-line options, so you can
-use the -c option to specify an alternate configuration file.
-"""
-
-import os
-import shutil
-import sys
-import tempfile
-
-from optparse import OptionParser
-
-tmpeggs = tempfile.mkdtemp()
-
-usage = '''\
-[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
-
-Bootstraps a buildout-based project.
-
-Simply run this script in a directory containing a buildout.cfg, using the
-Python that you want bin/buildout to use.
-
-Note that by using --find-links to point to local resources, you can keep
-this script from going over the network.
-'''
-
-parser = OptionParser(usage=usage)
-parser.add_option("-v", "--version", help="use a specific zc.buildout version")
-
-parser.add_option("-t", "--accept-buildout-test-releases",
-                  dest='accept_buildout_test_releases',
-                  action="store_true", default=False,
-                  help=("Normally, if you do not specify a --version, the "
-                        "bootstrap script and buildout gets the newest "
-                        "*final* versions of zc.buildout and its recipes and "
-                        "extensions for you.  If you use this flag, "
-                        "bootstrap and buildout will get the newest releases "
-                        "even if they are alphas or betas."))
-parser.add_option("-c", "--config-file",
-                  help=("Specify the path to the buildout configuration "
-                        "file to be used."))
-parser.add_option("-f", "--find-links",
-                  help=("Specify a URL to search for buildout releases"))
-parser.add_option("--allow-site-packages",
-                  action="store_true", default=False,
-                  help=("Let bootstrap.py use existing site packages"))
-parser.add_option("--setuptools-version",
-                  help="use a specific setuptools version")
-
-
-options, args = parser.parse_args()
-
-######################################################################
-# load/install setuptools
-
-try:
-    if options.allow_site_packages:
-        import setuptools
-        import pkg_resources
-    from urllib.request import urlopen
-except ImportError:
-    from urllib2 import urlopen
-
-ez = {}
-exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
-
-if not options.allow_site_packages:
-    # ez_setup imports site, which adds site packages
-    # this will remove them from the path to ensure that incompatible versions
-    # of setuptools are not in the path
-    import site
-    # inside a virtualenv, there is no 'getsitepackages'.
-    # We can't remove these reliably
-    if hasattr(site, 'getsitepackages'):
-        for sitepackage_path in site.getsitepackages():
-            sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
-
-setup_args = dict(to_dir=tmpeggs, download_delay=0)
-
-if options.setuptools_version is not None:
-    setup_args['version'] = options.setuptools_version
-
-ez['use_setuptools'](**setup_args)
-import setuptools
-import pkg_resources
-
-# This does not (always?) update the default working set.  We will
-# do it.
-for path in sys.path:
-    if path not in pkg_resources.working_set.entries:
-        pkg_resources.working_set.add_entry(path)
-
-######################################################################
-# Install buildout
-
-ws = pkg_resources.working_set
-
-cmd = [sys.executable, '-c',
-       'from setuptools.command.easy_install import main; main()',
-       '-mZqNxd', tmpeggs]
-
-find_links = os.environ.get(
-    'bootstrap-testing-find-links',
-    options.find_links or
-    ('http://downloads.buildout.org/'
-     if options.accept_buildout_test_releases else None)
-    )
-if find_links:
-    cmd.extend(['-f', find_links])
-
-setuptools_path = ws.find(
-    pkg_resources.Requirement.parse('setuptools')).location
-
-requirement = 'zc.buildout'
-version = options.version
-if version is None and not options.accept_buildout_test_releases:
-    # Figure out the most recent final version of zc.buildout.
-    import setuptools.package_index
-    _final_parts = '*final-', '*final'
-
-    def _final_version(parsed_version):
-        try:
-            return not parsed_version.is_prerelease
-        except AttributeError:
-            # Older setuptools
-            for part in parsed_version:
-                if (part[:1] == '*') and (part not in _final_parts):
-                    return False
-            return True
-
-    index = setuptools.package_index.PackageIndex(
-        search_path=[setuptools_path])
-    if find_links:
-        index.add_find_links((find_links,))
-    req = pkg_resources.Requirement.parse(requirement)
-    if index.obtain(req) is not None:
-        best = []
-        bestv = None
-        for dist in index[req.project_name]:
-            distv = dist.parsed_version
-            if _final_version(distv):
-                if bestv is None or distv > bestv:
-                    best = [dist]
-                    bestv = distv
-                elif distv == bestv:
-                    best.append(dist)
-        if best:
-            best.sort()
-            version = best[-1].version
-if version:
-    requirement = '=='.join((requirement, version))
-cmd.append(requirement)
-
-import subprocess
-if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
-    raise Exception(
-        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
-
-######################################################################
-# Import and run buildout
-
-ws.add_entry(tmpeggs)
-ws.require(requirement)
-import zc.buildout.buildout
-
-if not [a for a in args if '=' not in a]:
-    args.append('bootstrap')
-
-# if -c was provided, we push it back into args for buildout' main function
-if options.config_file is not None:
-    args[0:0] = ['-c', options.config_file]
-
-zc.buildout.buildout.main(args)
-shutil.rmtree(tmpeggs)

release.py

@@ -9,7 +9,7 @@ date should be a string like "23-Sep-2003"
 The following files are updated:
     - setup.py
     - NEWS.txt
-    - doc/guide/zodb.tex
+    - docs/guide/zodb.tex
     - src/ZEO/__init__.py
     - src/ZEO/version.txt
     - src/ZODB/__init__.py
@@ -73,7 +73,7 @@ def main(args):
     replace("NEWS.txt",
             r"^Release date: .*",
             "Release date: %s" % date)
-    replace("doc/guide/zodb.tex",
+    replace("docs/guide/zodb.tex",
             r"release{\S+}",
             "release{%s}" % version)
 if __name__ == "__main__":

setup.cfg

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
 [bdist_wheel]
 universal = 1
+
+[flake8]
+doctests = 1
+
+[check-manifest]
+ignore =
+    .editorconfig
+    .meta.toml
+    docs/_build/html/_sources/*

setup.py

@@ -30,12 +30,16 @@ install_requires = [
 tests_require = [
     # We rely on implementation details of
     # test mocks. See https://github.com/zopefoundation/ZODB/pull/222
+    'ZConfig',
     'ZODB >= 5.5.1',
+    'ZopeUndo',
     'zope.testing',
     'manuel',
     'random2',
+    'transaction',
     'mock',
     'msgpack < 1',
+    'zdaemon',
     'zope.testrunner',
 ]
 

tox.ini

+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
 [tox]
+minversion = 3.18
 envlist =
+    lint
     py27
     py35
     py36
@@ -9,50 +13,78 @@ envlist =
     py310
     pypy
     pypy3
-    simple
     docs
+    coverage
 
 [testenv]
-commands =
-# Run unit tests first.
-    zope-testrunner -u --test-path=src {posargs:-vc}
-# Only run functional tests if unit tests pass.
-    zope-testrunner -f --test-path=src {posargs:-vc}
+usedevelop = true
 deps =
     !zodbmaster: ZODB >= 4.2.0b1
     zodbmaster: -e git+https://github.com/zopefoundation/ZODB.git@master#egg=ZODB
     uvloop: uvloop
-    random2
-    ZConfig
-    manuel
-    persistent >= 4.1.0
-    transaction
-    zc.lockfile
-    zdaemon
-    zope.interface
-    zope.testing
-    zope.testrunner
-    mock
-    msgpack < 1
-# ZopeUndo is needed as soft-dependency for a regression test
-    ZopeUndo
 setenv =
     !py27-!pypy: PYTHONWARNINGS=ignore::ResourceWarning
     msgpack1: ZEO_MSGPACK=1
     zeo4: ZEO4_SERVER=1
+commands =
+    # Run unit tests first.
+    zope-testrunner -u --test-path=src {posargs:-vc}
+    # Only run functional tests if unit tests pass.
+    zope-testrunner -f --test-path=src {posargs:-vc}
+extras =
+    test
 
-[testenv:simple]
-# Test that 'setup.py test' works
-basepython =
-    python3
+[testenv:lint]
+basepython = python3
+skip_install = true
+deps =
+    check-manifest
+    check-python-versions >= 0.19.1
+    wheel
 commands =
-    python setup.py -q test -q
-deps = {[testenv]deps}
+    check-manifest
+    check-python-versions
 
 [testenv:docs]
-basepython =
-    python3
-commands =
-    sphinx-build -b html doc doc/_build/html
+basepython = python3
+skip_install = false
 extras =
     docs
+commands_pre =
+commands =
+    sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
+
+[testenv:coverage]
+basepython = python3
+allowlist_externals =
+    mkdir
+deps =
+    coverage
+    coverage-python-version
+    !zodbmaster: ZODB >= 4.2.0b1
+    zodbmaster: -e git+https://github.com/zopefoundation/ZODB.git@master#egg=ZODB
+    uvloop: uvloop
+commands =
+    mkdir -p {toxinidir}/parts/htmlcov
+    coverage run -m zope.testrunner --test-path=src {posargs:-vc}
+    coverage html
+    coverage report -m --fail-under=53
+
+[coverage:run]
+branch = True
+plugins = coverage_python_version
+source = ZEO
+
+[coverage:report]
+precision = 2
+exclude_lines =
+    pragma: no cover
+    pragma: nocover
+    except ImportError:
+    raise NotImplementedError
+    if __name__ == '__main__':
+    self.fail
+    raise AssertionError
+
+[coverage:html]
+directory = parts/htmlcov