- packaging cleanups

.meta.toml

@@ -24,3 +24,8 @@ additional-rules = [
     "recursive-include src *.txt",
     "recursive-include src *.zcml",
     ]
+
+[check-manifest]
+additional-ignores = [
+    "docs/_build/html/_static/*",
+    ]

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing to dataflake projects
+
+The projects under the dataflake GitHub organization are open source and
+welcome contributions in different forms:
+
+* bug reports
+* code improvements and bug fixes
+* documentation improvements

COPYRIGHT.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2019-2023 Jens Vagelpohl 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.

MANIFEST.in

@@ -1,5 +1,6 @@
 # Generated from:
 # https://github.com/zopefoundation/meta/tree/master/config/zope-product
+include *.md
 include *.rst
 include *.txt
 include buildout.cfg

docs/Makefile

@@ -1,9 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = ../bin/sphinx-build
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= ../bin/sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/_static/README.txt

@@ -0,0 +1 @@
+Place for static files

docs/conf.py

@@ -1,54 +1,41 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import datetime
+import os
+import pkginfo
+import sys
 
+parent = os.path.dirname(os.path.dirname(__file__))
+parent_dir = os.path.abspath(parent)
+pkg_info = pkginfo.Develop(parent_dir)
+pkg_version = pkg_info.version or ''
+year = datetime.datetime.now().year
 
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'dataflake.wsgi.cheroot'
-copyright = '2019, Jens Vagelpohl and Contributors'
-author = 'Jens Vagelpohl and Contributors'
+copyright = '2019-%i, Jens Vagelpohl and Contributors' % year
+author = 'Jens Vagelpohl'
 
+# The short X.Y version.
+version = pkg_version.replace('.dev0', '')
+# The full version, including alpha/beta/rc tags.
+release = pkg_version
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-]
-
-# Add any paths that contain templates here, relative to this directory.
+extensions = []
 templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-master_doc = 'index'
-
+language = 'en'
 
 # -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']

setup.cfg

@@ -13,6 +13,7 @@ ignore =
     .editorconfig
     .meta.toml
     docs/_build/html/_sources/*
+    docs/_build/html/_static/*
 
 [isort]
 force_single_line = True

setup.py

@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2019 Jens Vagelpohl and Contributors.
+# Copyright (c) 2019-2023 Jens Vagelpohl and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,
@@ -17,23 +17,20 @@
 from setuptools import setup
 
 
-NAME = 'dataflake.wsgi.cheroot'
-URL = f'https://github.com/dataflake/{NAME}'
-
-
 def read(*rnames):
     with open(os.path.join(os.path.dirname(__file__), *rnames)) as f:
         return f.read()
 
 
 setup(
-    name=NAME,
+    name='dataflake.wsgi.cheroot',
     version='2.1.dev0',
-    url=URL,
+    url='https://github.com/dataflake/dataflake.wsgi.cheroot',
     project_urls={
         'Documentation': 'https://dataflakewsgicheroot.readthedocs.io',
-        'Issue Tracker': f'{URL}/issues',
-        'Sources': URL,
+        'Issue Tracker': ('https://github.com/dataflake/'
+                          'dataflake.wsgi.cheroot/issues'),
+        'Sources': 'https://github.com/dataflake/dataflake.wsgi.cheroot',
     },
     license='ZPL 2.1',
     description='PasteDeploy entry point for the cheroot WSGI server',
@@ -73,6 +70,7 @@ def read(*rnames):
         'docs': [
             'Sphinx',
             'sphinx_rtd_theme',
+            'pkginfo',
         ],
     },
     entry_points={

src/dataflake/wsgi/cheroot/__init__.py

@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2019 Jens Vagelpohl and Contributors.
+# Copyright (c) 2019-2023 Jens Vagelpohl and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,

src/dataflake/wsgi/cheroot/configurator.py

@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2019 Jens Vagelpohl and Contributors.
+# Copyright (c) 2019-2023 Jens Vagelpohl and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,

src/dataflake/wsgi/cheroot/tests/__init__.py

@@ -1,13 +1 @@
-##############################################################################
-#
-# Copyright (c) 2019 Jens Vagelpohl 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.
-#
-##############################################################################
+# package me

src/dataflake/wsgi/cheroot/tests/test_cheroot_initialization.py

@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2019 Jens Vagelpohl and Contributors.
+# Copyright (c) 2019-2023 Jens Vagelpohl and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,

src/dataflake/wsgi/cheroot/tests/test_configbuilder.py

@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2019 Jens Vagelpohl and Contributors.
+# Copyright (c) 2019-2023 Jens Vagelpohl and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,