feature/2/create-first-version

.github/workflows/build.yaml

@@ -0,0 +1,38 @@
+---
+# build.yaml
+#
+# GitHub Action Build Workflow CI/CD configuration.
+#
+# author  : stefan schablowski
+# contact : stefan.schablowski@desmodyne.com
+# created : 2025-03-23
+
+
+# uv > Using uv in GitHub Actions:
+#   https://docs.astral.sh/uv/guides/integration/github
+
+
+name: Build
+on:   [push]
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: 0.6.9
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: code/python/pyproject.toml
+
+      - name: Run `uv build`
+        run: uv build --directory code/python

.github/workflows/publish.yaml

@@ -0,0 +1,88 @@
+---
+# publish.yaml
+#
+# GitHub Action Publish Workflow CI/CD configuration.
+#
+# author  : stefan schablowski
+# contact : stefan.schablowski@desmodyne.com
+# created : 2025-03-23
+
+
+# Publishing a Python Package from GitHub to PyPI in 2024:
+#   https://medium.com/@blackary/ ...
+#    ... publishing-a-python-package-from-github-to-pypi-in-2024-a6fb8635d45d
+# configuration in here adapted from "Step 3"
+
+
+name: Publish
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    environment:
+      name: pypi
+      url:  https://pypi.org/p/keyring-insecure-backend
+    name: publish
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: 0.6.9
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: code/python/pyproject.toml
+
+      # NOTE: these two jobs don't agree on where the package is built:
+      #  + `uv build` out of the box builds package in .../code/python/dist
+      #  + `gh-action-pypi-publish` action fails with error message
+      #       No such file or directory: '/github/workspace/dist'
+      #    so ostensibly, expects package there
+      #  + attempting to adapt `uv build` to action fails with
+      #      failed to create directory `/github/workspace/dist`:
+      #        Permission denied
+      # --> enforce corporate convention `.../tmp/artifacts` unto both:
+      #  1. in `uv build` call, add `--out-dir`:
+      #       https://docs.astral.sh/uv/reference/cli/#uv-build--out-dir
+      #  2. in `gh-action-pypi-publish` action, configure `packages-dir`:
+      #       https://github.com/marketplace/actions/pypi-publish ...
+      #        ... #customizing-target-package-dists-directory
+      # TODO: don't run `uv build` here again, but set up artifact in build job
+
+      - name: Run `uv build`
+        run: uv build --directory code/python --out-dir tmp/artifacts
+
+      # TODO: from the GitHub action log:
+      #   Checking tmp/artifacts/dist/keyring_insecure_backend-0.0.1-py3-none-any.whl: PASSED with warnings
+      #   WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.
+      #   WARNING  `long_description` missing.
+      #   Checking tmp/artifacts/dist/keyring_insecure_backend-0.0.1.tar.gz: PASSED with warnings
+      #   WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.
+      #   WARNING  `long_description` missing.
+      # also, from https://pypi.org/project/keyring-insecure-backend:
+      #   The author of this package has not provided a project description
+      # --> `long_description` was supported in `setup.py` (or `setup.cfg`):
+      #        https://github.com/pypi/warehouse/issues/4036
+      #        https://packaging.python.org/en/latest/guides/ ...
+      #         ... making-a-pypi-friendly-readme/#including- ...
+      #         ... your-readme-in-your-package-s-metadata
+      #        https://stackoverflow.com/a/58062850
+      #        https://github.com/pypa/packaging.python.org/ ...
+      #         ... issues/1535#issuecomment-2072711593
+      #     but is not supported in pyproject.toml 🤦🏻‍♂️
+      #     python packaging is just a sad laughing stock 😞
+      # TODO: see e.g. https://pypi.org/project/uv for possible project info
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: tmp/artifacts

.github/workflows/sync.yaml

@@ -0,0 +1,37 @@
+---
+# sync.yaml
+#
+# GitHub Action Sync Workflow CI/CD configuration.
+#
+# author  : stefan schablowski
+# contact : stefan.schablowski@desmodyne.com
+# created : 2025-03-23
+
+
+# see ./build.yaml
+
+
+name: Sync
+on:   [push]
+
+jobs:
+  sync:
+    name: sync
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: 0.6.9
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: code/python/pyproject.toml
+
+      - name: Run `uv sync`
+        run: uv sync --directory code/python

.vscode/settings.json

@@ -0,0 +1,51 @@
+// settings.json
+//
+// Visual Studio Code workspace settings
+//
+// author  : stefan schablowski
+// contact : stefan.schablowski@desmodyne.com
+// created : 2021-09-25
+
+
+// NOTE: file suffix says .json, but actual file format is some proprietary
+// Microsoft mess: mostly a json file, but with JavaScript-style (?) comments;
+// can't be read/modified or even displayed properly by regular json tools :-/
+
+// NOTE: VS Code user ./. workspace settings:
+// + user settings are stored in
+//     $HOME/Library/Application Support/Code/User/settings.json
+// + workspace settings are stored in
+//     .../.vscode/settings.json
+// + workspace settings take precedence over user settings:
+//   https://code.visualstudio.com/docs/getstarted/settings#_settings-precedence
+//
+// TODO: review VS Code settings, move from user to workspace settings
+// TODO: review VS Code analysis / linting / etc. settings:
+//   https://code.visualstudio.com/docs/python/settings-reference
+
+
+{
+  // make auto indentation less dumb
+  "editor.autoIndent": "advanced",
+  // display a vertical line at 80 characters
+  "editor.rulers":     [ 80 ],
+
+  // remove trailing whitespace upon saving files
+  "files.trimTrailingWhitespace": true,
+
+  // pylance > pyright settings
+  "python.analysis.diagnosticMode":   "workspace",
+  "python.analysis.exclude": [
+    "attic",
+    "code/python/.venv",
+    "doc/python/.venv",
+    "tmp"
+  ],
+  "python.analysis.typeCheckingMode": "strict",
+
+  // NOTE: one single argument is probably not worth creating a shell frontend
+  "shellcheck.customArgs": [
+    "--enable=all",
+    "-x"
+  ]
+}

code/python/keyring_insecure_backend/ConfFileModel.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+"""
+ConfFileModel.py
+
+Insecure Keyring Backend configuration file data model.
+
+author  : stefan schablowski
+contact : stefan.schablowski@desmodyne.com
+created : 2025-03-11
+"""
+
+
+from pathlib import Path
+
+# https://pypi.org/project/pydantic
+from pydantic import BaseModel, ConfigDict
+
+from .ConfRichLoggingModel import ConfRichLoggingModel
+
+
+# -----------------------------------------------------------------------------
+# public types
+
+class ConfFileModel(BaseModel):
+    """
+    Pydantic model that defines configuration file attributes.
+    """
+
+    model_config = ConfigDict(extra='forbid')
+    logging:           ConfRichLoggingModel
+    path_to_data_file: Path