Sync project with template. Regenerate model

softboiler · Apr 2, 2024 · 76e6c98 · 76e6c98
1 parent 87fd20e
commit 76e6c98
Show file tree

Hide file tree

Showing 70 changed files with 1,775 additions and 914 deletions.
diff --git a/codecov.yml → .codecov.yml b/codecov.yml → .codecov.yml
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,7 +1,7 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 22b0caa
+_commit: c69e3b8
 _src_path: gh:blakeNaccarato/copier-python
-actions_runner: ubuntu-latest
+actions_runner: ubuntu-22.04
 active: true
 github_repo_name: boilercore
 project_description: Common functionality of boiler repositories.

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,94 @@
+{
+  "name": "devcontainer",
+  "image": "mcr.microsoft.com/devcontainers/base:1.0.22-ubuntu-22.04",
+  "features": {
+    "ghcr.io/devcontainers/features/powershell:1.3.4": {
+      "version": "7.4.1"
+    },
+    "ghcr.io/devcontainers/features/python:1.4.2": {
+      "version": "3.11"
+    },
+    "ghcr.io/devcontainers/features/desktop-lite:1.0.8": {
+      "noVncVersion": "1.4.0"
+    },
+    "ghcr.io/dhoeric/features/google-cloud-cli:1.0.1": {
+      "version": "470.0.0"
+    },
+    "ghcr.io/joshuanianji/devcontainer-features/gcloud-cli-persistence:1.0.3": {}
+  },
+  "onCreateCommand": {
+    "set-up-profile": [
+      "pwsh",
+      "-Command",
+      "New-Item -Force $PROFILE && Copy-Item scripts/Initialize-Shell.ps1 $PROFILE"
+    ],
+    "gcloud-login-for-dvc": [
+      "pwsh",
+      "-Command",
+      "if (!(Test-Path /.codespaces)) { gcloud auth application-default login }"
+    ]
+  },
+  "postCreateCommand": {
+    "sync-py-in-codespace": [
+      "pwsh",
+      "-Command",
+      "if (Test-Path /.codespaces) { scripts/Sync-Py.ps1 }"
+    ]
+  },
+  "postAttachCommand": {
+    "sync-py": ["pwsh", "scripts/Sync-Py.ps1"]
+  },
+  "containerEnv": {
+    "DEVCONTAINER": "1",
+    "PIP_DISABLE_PIP_VERSION_CHECK": "1",
+    "PYDEVD_DISABLE_FILE_VALIDATION": "1",
+    "PYTHONIOENCODING": "utf-8:strict",
+    "PYTHONUTF8": "1",
+    "PYTHONWARNDEFAULTENCODING": "1",
+    "PYTHONWARNINGS": "ignore"
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "notebook.experimental.remoteSave": true,
+        "python.experiments.enabled": true,
+        "python.experiments.optInto": [
+          "pythonDiscoveryUsingWorkers",
+          "pythonREPLSmartSend",
+          "pythonTestAdapter",
+          "pythonTerminalEnvVarActivation"
+        ]
+      },
+      "extensions": [
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]"
+      ]
+    }
+  }
+}
diff --git a/.env b/.env
diff --git a/.github/workflows/changerelease.yml b/.github/workflows/changerelease.yml
@@ -1,16 +1,25 @@
+# Sync GitHub release notes with the changelog
 name: "changerelease"
 on:
-  workflow_dispatch: {}
+  workflow_dispatch:
   push:
-    paths: ["CHANGELOG.md"]
     branches: ["main"]
     tags: ["*"]
-
+    paths: ["CHANGELOG.md"]
+defaults:
+  run:
+    shell: "pwsh"
 jobs:
-  sync:
-    runs-on: "ubuntu-latest"
+  changerelease:
+    strategy:
+      matrix:
+        runner: ["ubuntu-22.04"]
+        python: ["3.11"]
+    permissions:
+      contents: "write"
+    runs-on: "${{ matrix.runner }}"
     steps:
-      - uses: "dropseed/[email protected]"
+      - uses: "dropseed/changerelease@3b121c9e98fa055f59a32b023cb4fd2325f4d9dc" # v1.6.0
         with:
           github_token: "${{ secrets.GITHUB_TOKEN }}"
           tag_prefix: ""
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,142 @@
+# Run static analysis, tests, and sync
+name: "ci"
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: True
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: ["main"]
+defaults:
+  run:
+    shell: "pwsh"
+env:
+  UV_CACHE_DIR: ".cache/uv-cache"
+  UV_SYSTEM_PYTHON: "true"
+jobs:
+  ruff:
+    strategy:
+      matrix:
+        runner: ["ubuntu-22.04"]
+        python: ["3.11"]
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - run: "scripts/Sync-Py.ps1"
+      - run: "ruff check --no-fix --output-format github ."
+  fawltydeps:
+    strategy:
+      matrix:
+        runner: ["ubuntu-22.04"]
+        python: ["3.11"]
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - run: "scripts/Sync-Py.ps1"
+      - run: "fawltydeps"
+  pyright:
+    strategy:
+      matrix:
+        runner: ["ubuntu-22.04"]
+        python: ["3.11"]
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - run: "scripts/Sync-Py.ps1"
+      - run: pyright
+  test:
+    strategy:
+      matrix:
+        runner:
+          - "macos-13"
+          - "macos-14"
+          - "ubuntu-22.04"
+          - "windows-2022"
+        python:
+          # - "3.10"  # `scripts` currently requires `tomllib`, which is > 3.10
+          - "3.11"
+          - "3.12"
+          # - "3.13.0-alpha.5"  # https://github.com/PyO3/pyo3/issues/3555
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - run: "scripts/Sync-Py.ps1 -Version '${{ matrix.python }}'"
+      # ! https://github.com/pytest-dev/pytest-cov/issues/479#issuecomment-1247444988
+      - run: "pytest --cov --cov-config pyproject.toml"
+      - if: startsWith(matrix.runner, 'ubuntu') && matrix.python == '3.11'
+        uses: "codecov/codecov-action@54bcd8715eee62d40e33596ef5e8f0f48dbbccab" # v4.1.0
+        env:
+          CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"
+      - uses: "actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3" # v4.3.1
+        with:
+          path: ".comps"
+          name: "requirements_${{ matrix.runner }}_${{ matrix.python }}"
+  sync:
+    strategy:
+      matrix:
+        runner: ["ubuntu-22.04"]
+        python: ["3.11"]
+    permissions:
+      contents: "write"
+    needs:
+      - "ruff"
+      - "fawltydeps"
+      - "pyright"
+      - "test"
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - uses: "actions/download-artifact@c850b930e6ba138125429b7e5c93fc707a7f8427" # v4.1.4
+        with:
+          path: ".comps"
+          merge-multiple: True
+      - run: "scripts/Sync-Py.ps1 -Lock"
+      - uses: "stefanzweifel/git-auto-commit-action@8756aa072ef5b4a080af5dc8fef36c5d586e521d" # v5.0.0
+        with:
+          commit_message: "Sync and lock"
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml
@@ -0,0 +1,69 @@
+# Simulate local contributor workflow sync process
+name: "contrib"
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - ".github/workflows/contrib.yml"
+      - "scripts/Sync-Py.ps1"
+      - "scripts/boilercore_tools/**"
+      - "scripts/pyproject.toml"
+  push:
+    branches: ["main"]
+    paths:
+      - ".github/workflows/contrib.yml"
+      - "scripts/Sync-Py.ps1"
+      - "scripts/boilercore_tools/**"
+      - "scripts/pyproject.toml"
+defaults:
+  run:
+    shell: "pwsh"
+env:
+  UV_CACHE_DIR: ".cache/uv-cache"
+  SYNC_PY_DISABLE_CI: True
+jobs:
+  no-spaces-in-path:
+    strategy:
+      matrix:
+        runner:
+          - "macos-13"
+          - "ubuntu-22.04"
+          - "windows-2022"
+        python: ["3.11"]
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - run: "scripts/Sync-Py.ps1 -Lock -Version '3.11'"
+  spaces-in-path:
+    strategy:
+      matrix:
+        runner:
+          - "macos-13"
+          - "ubuntu-22.04"
+          - "windows-2022"
+        python: ["3.11"]
+    runs-on: "${{ matrix.runner }}"
+    steps:
+      - run: "New-Item -ItemType Directory 'repo path with spaces'"
+      - uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+        with:
+          submodules: True
+          path: "repo path with spaces"
+      - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        with:
+          path: "${{ env.UV_CACHE_DIR }}"
+          key: "uv-${{ matrix.runner }}"
+      - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0
+        with:
+          python-version: "${{ matrix.python }}"
+      - working-directory: "repo path with spaces"
+        run: "scripts/Sync-Py.ps1 -Lock -Version '3.11'"