Merge https://github.com/cisagov/skeleton-python-library into lineage/skeleton

# Conflicts:
#	.github/workflows/build.yml
#	.pre-commit-config.yaml
#	src/example/example.py
#	src/pshtt/_version.py

Author: mcdonnnj

.github/workflows/build.yml

@@ -203,12 +203,13 @@ jobs:
         uses: mxschmitt/action-tmate@v3
         if: env.RUN_TMATE
   test:
-    name: test source - py${{ matrix.python-version }}
+    name: test source - py${{ matrix.python-version }} - ${{ matrix.platform }}
     needs:
       - diagnostics
     permissions:
       # actions/checkout needs this to fetch code
       contents: read
+<<<<<<< HEAD
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -218,6 +219,19 @@ jobs:
             python-version: "3.7"
         os:
           - ubuntu-latest
+=======
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # We test on all of the latest platforms available to use with GitHub-
+        # hosted runners for public repositories.
+        platform:
+          - macos-latest
+          - ubuntu-24.04-arm
+          - ubuntu-latest
+          - windows-latest
+>>>>>>> b122bbddb6b6be656c655a1049d88bbdf12f940a
         python-version:
           - "3.8"
           - "3.9"
@@ -259,7 +273,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: actions/cache@v4
         env:
-          BASE_CACHE_KEY: ${{ github.job }}-${{ runner.os }}-\
+          BASE_CACHE_KEY: ${{ github.job }}-\
+            ${{ runner.os }}-${{ runner.arch }}-\
             py${{ steps.setup-python.outputs.python-version }}-
         with:
           path: ${{ env.PIP_CACHE_DIR }}
@@ -418,13 +433,14 @@ jobs:
         uses: mxschmitt/action-tmate@v3
         if: env.RUN_TMATE
   test-build:
-    name: test built wheel - py${{ matrix.python-version }}
+    name: test built wheel - py${{ matrix.python-version }} - ${{ matrix.platform }}
     needs:
       - diagnostics
       - build
     permissions:
       # actions/checkout needs this to fetch code
       contents: read
+<<<<<<< HEAD
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -434,6 +450,19 @@ jobs:
             python-version: "3.7"
         os:
           - ubuntu-latest
+=======
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # We test on all of the latest platforms available to use with GitHub-
+        # hosted runners for public repositories.
+        platform:
+          - macos-latest
+          - ubuntu-24.04-arm
+          - ubuntu-latest
+          - windows-latest
+>>>>>>> b122bbddb6b6be656c655a1049d88bbdf12f940a
         python-version:
           - "3.8"
           - "3.9"
@@ -475,7 +504,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: actions/cache@v4
         env:
-          BASE_CACHE_KEY: ${{ github.job }}-${{ runner.os }}-\
+          BASE_CACHE_KEY: ${{ github.job }}-\
+            ${{ runner.os }}-${{ runner.arch }}-\
             py${{ steps.setup-python.outputs.python-version }}-
         with:
           path: ${{ env.PIP_CACHE_DIR }}

.pre-commit-config.yaml

@@ -218,6 +218,7 @@ repos:
       - id: pyupgrade
 
   # Ansible hooks
+<<<<<<< HEAD
   # - repo: https://github.com/ansible/ansible-lint
   #   # ansible-lint no longer supports Python 3.7 as of version 6.0, so
   #   # we cannot upgrade past the 5.4.0 release:
@@ -269,6 +270,50 @@ repos:
   #         # made in requirements.txt in cisagov/skeleton-packer and
   #         # requirements-test.txt in cisagov/skeleton-ansible-role.
   #         - ansible-core>=2.17
+=======
+  - repo: https://github.com/ansible/ansible-lint
+    rev: v25.4.0
+    hooks:
+      - id: ansible-lint
+        additional_dependencies:
+          # On its own ansible-lint does not pull in ansible, only
+          # ansible-core.  Therefore, if an Ansible module lives in
+          # ansible instead of ansible-core, the linter will complain
+          # that the module is unknown.  In these cases it is
+          # necessary to add the ansible package itself as an
+          # additional dependency, with the same pinning as is done in
+          # requirements-test.txt of cisagov/skeleton-ansible-role.
+          #
+          # Version 10 is required because the pip-audit pre-commit
+          # hook identifies a vulnerability in ansible-core 2.16.13,
+          # but all versions of ansible 9 have a dependency on
+          # ~=2.16.X.
+          #
+          # It is also a good idea to go ahead and upgrade to version
+          # 10 since version 9 is going EOL at the end of November:
+          # https://endoflife.date/ansible
+          # - ansible>=10,<11
+          # ansible-core 2.16.3 through 2.16.6 suffer from the bug
+          # discussed in ansible/ansible#82702, which breaks any
+          # symlinked files in vars, tasks, etc. for any Ansible role
+          # installed via ansible-galaxy.  Hence we never want to
+          # install those versions.
+          #
+          # Note that the pip-audit pre-commit hook identifies a
+          # vulnerability in ansible-core 2.16.13.  The pin of
+          # ansible-core to >=2.17 effectively also pins ansible to
+          # >=10.
+          #
+          # It is also a good idea to go ahead and upgrade to
+          # ansible-core 2.17 since security support for ansible-core
+          # 2.16 ends this month:
+          # https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix
+          #
+          # Note that any changes made to this dependency must also be
+          # made in requirements.txt in cisagov/skeleton-packer and
+          # requirements-test.txt in cisagov/skeleton-ansible-role.
+          - ansible-core>=2.17
+>>>>>>> b122bbddb6b6be656c655a1049d88bbdf12f940a
 
   # Terraform hooks
   - repo: https://github.com/antonbabenko/pre-commit-terraform

src/example/example.py

@@ -0,0 +1,104 @@
+"""example is an example Python library and tool.
+
+Divide one integer by another and log the result. Also log some information
+from an environment variable and a package resource.
+
+EXIT STATUS
+    This utility exits with one of the following values:
+    0   Calculation completed successfully.
+    >0  An error occurred.
+
+Usage:
+  example [--log-level=LEVEL] <dividend> <divisor>
+  example (-h | --help)
+
+Options:
+  -h --help              Show this message.
+  --log-level=LEVEL      If specified, then the log level will be set to
+                         the specified value.  Valid values are "debug", "info",
+                         "warning", "error", and "critical". [default: info]
+"""
+
+# Standard Python Libraries
+from importlib.resources import files
+import logging
+import os
+import sys
+from typing import Any, Dict
+
+# Third-Party Libraries
+import docopt
+
+# There are no type stubs for the schema library, so mypy requires the type:
+# ignore hint.
+from schema import And, Schema, SchemaError, Use  # type: ignore
+
+from ._version import __version__
+
+DEFAULT_ECHO_MESSAGE: str = "Hello World from the example default!"
+
+
+def example_div(dividend: int, divisor: int) -> float:
+    """Print some logging messages."""
+    logging.debug("This is a debug message")
+    logging.info("This is an info message")
+    logging.warning("This is a warning message")
+    logging.error("This is an error message")
+    logging.critical("This is a critical message")
+    return dividend / divisor
+
+
+def main() -> None:
+    """Set up logging and call the example function."""
+    args: Dict[str, str] = docopt.docopt(__doc__, version=__version__)
+    # Validate and convert arguments as needed
+    schema: Schema = Schema(
+        {
+            "--log-level": And(
+                str,
+                Use(str.lower),
+                lambda n: n in ("debug", "info", "warning", "error", "critical"),
+                error="Possible values for --log-level are "
+                + "debug, info, warning, error, and critical.",
+            ),
+            "<dividend>": Use(int, error="<dividend> must be an integer."),
+            "<divisor>": And(
+                Use(int),
+                lambda n: n != 0,
+                error="<divisor> must be an integer that is not 0.",
+            ),
+            str: object,  # Don't care about other keys, if any
+        }
+    )
+
+    try:
+        validated_args: Dict[str, Any] = schema.validate(args)
+    except SchemaError as err:
+        # Exit because one or more of the arguments were invalid
+        print(err, file=sys.stderr)
+        sys.exit(1)
+
+    # Assign validated arguments to variables
+    dividend: int = validated_args["<dividend>"]
+    divisor: int = validated_args["<divisor>"]
+    log_level: str = validated_args["--log-level"]
+
+    # Set up logging
+    logging.basicConfig(
+        format="%(asctime)-15s %(levelname)s %(message)s", level=log_level.upper()
+    )
+
+    logging.info("%d / %d == %f", dividend, divisor, example_div(dividend, divisor))
+
+    # Access some data from an environment variable
+    message: str = os.getenv("ECHO_MESSAGE", DEFAULT_ECHO_MESSAGE)
+    logging.info('ECHO_MESSAGE="%s"', message)
+
+    # Access some data from our package data (see the setup.py)
+    secret_message: str = (
+        files(__package__).joinpath("data", "secret.txt").read_text().strip()
+    )
+    logging.info('Secret="%s"', secret_message)
+
+    # Stop logging and clean up
+    logging.shutdown()

src/pshtt/_version.py

@@ -1,3 +1,7 @@
 """This file defines the version of this module."""
 
+<<<<<<< HEAD:src/pshtt/_version.py
 __version__ = "0.7.1"
+=======
+__version__ = "0.2.2"
+>>>>>>> b122bbddb6b6be656c655a1049d88bbdf12f940a:src/example/_version.py