updates

Author: cloether

.github/workflows/cleanup.yml

@@ -6,7 +6,7 @@ jobs:
   validate-data:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Cleanup temporary files/directories
         run: |
           ./scripts/cleanup.py

.github/workflows/python-package.yml

@@ -21,7 +21,7 @@ jobs:
       matrix:
         python-version: [ 3.7, 3.8, 3.9 ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-alpine
+FROM python:3.13-alpine
 RUN mkdir /app
 WORKDIR /app
 COPY requirements.txt .
@@ -7,4 +7,4 @@ COPY . .
 ENV PYTHONPATH="/app"
 RUN addgroup -S projects && adduser -S -H projects -G projects
 RUN chown -R projects:projects /app
-USER projects
+USER projects

docs/source/conf.py

@@ -4,7 +4,7 @@
 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
+  https://www.sphinx-doc.org/en/master/config
 """
 from __future__ import absolute_import, print_function, unicode_literals
 
@@ -47,11 +47,11 @@
 #   https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
 #   https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.todo",
-    "sphinxcontrib.napoleon",
-    "guzzle_sphinx_theme"
+  "sphinx.ext.autodoc",
+  "sphinx.ext.viewcode",
+  "sphinx.ext.todo",
+  "sphinxcontrib.napoleon",
+  "guzzle_sphinx_theme"
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
@@ -93,12 +93,12 @@
 
 # Custom sidebar templates, filenames relative to this file.
 html_sidebars = {
-    "**": [
-        "logo-text.html",
-        "globaltoc.html",
-        "localtoc.html",
-        "searchbox.html"
-    ]
+  "**": [
+    "logo-text.html",
+    "globaltoc.html",
+    "localtoc.html",
+    "searchbox.html"
+  ]
 }
 
 # Output file base name for HTML help builder.
@@ -117,25 +117,25 @@
 # -- Options for LaTeX output ---------------------------------------
 
 latex_elements = {
-    # Paper size ("letterpaper" or "a4paper").
-    # "papersize": "letterpaper",
-    #
-    # The font size ("10pt", "11pt" or "12pt").
-    # "pointsize": "10pt",
-    #
-    # Additional stuff for the LaTeX preamble.
-    # "preamble": "",
+  # Paper size ("letterpaper" or "a4paper").
+  # "papersize": "letterpaper",
+  #
+  # The font size ("10pt", "11pt" or "12pt").
+  # "pointsize": "10pt",
+  #
+  # Additional stuff for the LaTeX preamble.
+  # "preamble": "",
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author,
 # documentclass [howto/manual]).
 latex_documents = [
-    ("index",
-     "{0}.tex".format(project),
-     "{0} Documentation".format(project),
-     author,
-     "manual")
+  ("index",
+   "{0}.tex".format(project),
+   "{0} Documentation".format(project),
+   author,
+   "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at
@@ -163,10 +163,10 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ("index", project,
-     "{0} Documentation".format(project),
-     [author],
-     3)
+  ("index", project,
+   "{0} Documentation".format(project),
+   [author],
+   3)
 ]
 
 # If true, show URL addresses after external links.
@@ -179,13 +179,13 @@
 #  dir menu entry, description, category)
 
 texinfo_documents = [
-    ("index",
-     project,
-     "{0} Documentation".format(project),
-     author,
-     project,
-     __description__,
-     "Miscellaneous"),
+  ("index",
+   project,
+   "{0} Documentation".format(project),
+   author,
+   project,
+   __description__,
+   "Miscellaneous"),
 ]
 
 # Documents to append as an appendix to all manuals.

pyproject.toml

@@ -0,0 +1,96 @@
+# pyproject.toml is a configuration file that is used to
+# specify the build system requirements for a Python project.
+#
+# References:
+# - [PEP-518](https://peps.python.org/pep-0518/)
+# - [PEP-517](https://peps.python.org/pep-0517/)
+# - [PEP-621](https://peps.python.org/pep-0621/)
+# - [PEP-660](https://peps.python.org/pep-0660/)
+# - [Python Packaging Reference - pyproject.toml](https://packaging.python.org/en/latest/specifications/pyproject-toml/#pyproject-toml-specification
+#
+# JSON Schema:
+#    {
+#      "$schema": "http://json-schema.org/schema#",
+#      "type": "object",
+#      "additionalProperties": false,
+#      "properties": {
+#        "build-system": {
+#          "type": "object",
+#          "additionalProperties": false,
+#          "properties": {
+#            "requires": {
+#              "type": "array",
+#              "items": {
+#                "type": "string"
+#              }
+#            }
+#          },
+#          "required": [
+#            "requires"
+#          ]
+#        },
+#        "tool": {
+#          "type": "object"
+#        }
+#      }
+#    }
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "skeleton"
+version = "0.0.10"
+description = "Python Module Template"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "Chad Loether", email = "chad.loether@outlook.com" }]
+keywords = ["template", "skeleton"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Natural Language :: English",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.6",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+dependencies = ["six", "appdirs"]
+
+[project.urls]
+Source = "https://github.com/cloether/skeleton"
+Tracker = "https://github.com/cloether/skeleton/issues"
+
+[tool.setuptools.packages.find]
+include = ["skeleton"]
+exclude = ["doc*", "example*", "script*", "test*"]
+
+[project.optional-dependencies]
+docs = ["sphinx", "sphinxcontrib-napoleon", "guzzle_sphinx_theme"]
+tests = [
+    "check-manifest",
+    "coverage",
+    "pycodestyle",
+    "pytest",
+    "pytest-cov",
+    "pytest-html",
+    "tox",
+    "tox-travis",
+    "twine",
+    "wheel"
+]
+python2.6 = ["ordereddict==1.1", "simplejson==3.3.0"]
+python2.7 = ["ipaddress"]
+
+[project.scripts]
+skeleton = "skeleton.__main__:main"

pytest.ini

@@ -1,21 +1,72 @@
-; References:
+; pytest.ini
+;
+; references:
 ;   https://docs.pytest.org/en/stable/
 ;   https://plugincompat.herokuapp.com/
-;suppress inspection for section "LongLine"
+
 [pytest]
-addopts = -rN --tb=short -p no:warnings --cache-clear --cov . --html=tests/reports/pytest.html --cov-config 'tests/.coveragerc' --self-contained-html
-cache_dir = tests/.pytest_cache
-log_cli = 1
+
+# minimum compatible pytest version
+minversion = 7.0
+
+; required plugins and version constraints
+required_plugins =
+  pytest-cov>=6.1.1
+  pytest-html>=4.1.1
+  pytest-json-report>=1.5.0
+
+# cli arguments to pass to pytest
+# TODO: look into '--cov=.'
+addopts =
+  -rN
+  --tb=short
+  -p no:warnings
+  --cache-clear
+  --cov=.
+  --cov-config=tests/.coveragerc
+  --cov-report=html:tests/reports/coverage.html
+  --cov-report=xml:tests/reports/coverage.xml
+  --cov-report=json:tests/reports/coverage.json
+  --cov-report=lcov:tests/reports/coverage.lcov
+  --self-contained-html
+  --html=tests/reports/results.html
+  --junitxml=tests/reports/results.xml
+  --json-report
+  --json-report-file=tests/reports/results.json
+  --json-report-indent=2
+
+; discover test files in this directory
+testpaths = tests
+python_files = tests/test_*.py
+norecursedirs =
+  .git
+  .idea
+  .tox
+  scripts
+  build
+  examples
+  docs
+
+; logging configuration for CLI
+log_cli = true
 log_cli_date_format = %Y-%m-%d %H:%M:%S
 log_cli_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
 log_cli_level = DEBUG
+
+; logging configuration for file output
 log_file = tests/logs/pytest.log
 log_file_date_format = %Y-%m-%d %H:%M:%S
 log_file_format = %(asctime)s [%(name)s] %(levelname)s: %(message)s
 log_file_level = DEBUG
 log_level = DEBUG
-norecursedirs = .git .idea .tox scripts build examples docs
-python_files = tests/test_*.py
+
+; pytest cache location
+cache_dir = tests/.pytest_cache
+
+; additional pytest-html setting (optional)
 render_collapsed = 1
-required_plugins = pytest-html pytest-cov
-testpaths = tests
+
+; marker declarations (if custom marks are used)
+markers =
+  slow: marks tests as slow (use with '-m "not slow"')
+  integration: marks integration tests