Testing

.github/workflows/build-deploy.yml

@@ -6,7 +6,7 @@ name: Build and deploy
 
 on:
   push:
-    branches: ["**"]
+    branches: ["dev"]
     tags: ["*"]
   pull_request:
     branches: ["dev"]
@@ -116,7 +116,7 @@ jobs:
           name: python-package
           path: dist/
       - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v3.10.0
+        uses: docker/setup-buildx-action@v3.11.1
       # Login against a Docker registry (only with a tag or push on `dev` branch)
       # https://github.com/docker/login-action
       - name: Log into Docker Hub

.github/workflows/python-tests.yml

@@ -13,21 +13,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    # https://github.com/actions/setup-python
-    - name: Set up Python
-      uses: actions/setup-python@v5
+    - name: Install uv and set the python version
+      id: setup-uv
+      uses: astral-sh/setup-uv@v6
       with:
-        python-version: '3.12'
-        cache: 'pip' # caching pip dependencies
-        # Manually set pyproject.toml as the file to use for dependencies
-        # Workaround while waiting for https://github.com/actions/setup-python/issues/529
-        cache-dependency-path: 'pyproject.toml'
-    - name: Run pre-commit
-      uses: pre-commit/[email protected]
-    - uses: pre-commit-ci/[email protected]
-      if: always()
+        version: "0.8.15" # It is considered best practice to pin to a specific uv version
+        # https://github.com/astral-sh/setup-uv?tab=readme-ov-file#enable-caching
+        enable-cache: true
+        cache-dependency-glob: |
+          **/*requirements*.txt
+          **/pyproject.toml
+          **/uv.lock
+
+    - name: Do something if the cache was restored
+      if: steps.setup-uv.outputs.cache-hit == 'true'
+      run: echo "Cache was restored"
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    - name: Run pre-commit hooks
+      run: >
+        uv run pre-commit
+        run --all-files
+        --show-diff-on-failure --color=always
 
   test:
+    needs: lint
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -36,18 +48,27 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    # https://github.com/actions/setup-python
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+    - name: Install uv and set the python version
+      id: setup-uv
+      uses: astral-sh/setup-uv@v6
       with:
+        # https://docs.astral.sh/uv/guides/integration/github/#multiple-python-versions
         python-version: ${{ matrix.python-version }}
-        cache: 'pip' # caching pip dependencies
-        # Manually set 'dev-requirements.txt' as the file to use for dependencies, since `requirements.txt` contains runtime dependencies.
-        cache-dependency-path: 'dev-requirements.txt'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r dev-requirements.txt
-    - name: Test with pytest
-      run: |
-        python -m pytest
+        version: "0.8.15" # It is considered best practice to pin to a specific uv version
+        # https://github.com/astral-sh/setup-uv?tab=readme-ov-file#enable-caching
+        enable-cache: true
+        cache-dependency-glob: |
+          **/*requirements*.txt
+          **/pyproject.toml
+          **/uv.lock
+
+    - name: Do something if the cache was restored
+      if: steps.setup-uv.outputs.cache-hit == 'true'
+      run: echo "Cache was restored"
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    - name: Run tests
+      # For example, using `pytest`
+      run: uv run pytest -m ci

.gitignore

@@ -10,6 +10,7 @@ __pycache__/
 .Python
 env/
 build/
+docker_build/
 docs_build/
 develop-eggs/
 dist/
@@ -65,6 +66,7 @@ target/
 venv
 .venv
 uv.lock
+*.ipynb
 
 # Mac stuff
 .DS_Store

.vscode/settings.json

@@ -1,5 +1,12 @@
 {
     "ruff.configuration": "pyproject.toml",
     "notebook.defaultFormatter": "charliermarsh.ruff",
-    "ruff.lineLength": 200
+    "ruff.lineLength": 200,
+    "python.analysis.typeCheckingMode": "basic",
+    "python.testing.pytestArgs": [
+        "-s",
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.autoTestDiscoverOnSavePattern": "tests/**/*.py",
 }

.vscode/tasks.json

@@ -18,111 +18,184 @@
                 },
         },
         {
-            "label": "Build Docs",
-            "command": "sphinx-build",
-            "args": ["-T", "-E", "${workspaceFolder}/docs", "${workspaceFolder}/.docs_build"],
+            "label": "Build Package",
+            "detail": "Builds the package as a wheel file in the dist/ directory",
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": ["build", "--wheel"],
             "presentation":
                 {
-                    "echo": true,
                     "reveal": "always",
+                    "clear": true,
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
-                    "clear": true
                 },
         },
         {
-            "label": "Auto Build Docs",
-            "command": "sphinx-autobuild",
-            "args": ["-T", "-E", "${workspaceFolder}/docs", "${workspaceFolder}/.docs_build", "--port", "9999"],
+            "label": "Build Docker Image",
+            "detail": "Builds the Docker image for the application",
+            "dependsOn": "Build Package",
+            "type": "shell",
+            "problemMatcher": [],
+            "command": "docker",
+            "args": [
+                "build",
+                "-t", "acockburn/appdaemon:local-dev",
+                // "-f", "Dockerfile.uv",
+                "${workspaceFolder}"
+            ],
+            "presentation":
+                {
+                    "reveal": "always",
+                    "clear": true,
+                    "focus": false,
+                    "panel": "shared",
+                },
+        },
+        {
+            "label": "Build Multi-Platform Docker Images",
+            "detail": "Builds Docker images for multiple platforms and analyzes their sizes",
+            "type": "shell",
+            "problemMatcher": [],
+            "command": "${workspaceFolder}/scripts/multiplatform-docker-build.sh",
+            "group": "build",
+            "presentation":
+                {
+                    "reveal": "always",
+                    "clear": true,
+                    "focus": true,
+                    "panel": "shared",
+                },
+        },
+        {
+            "label": "Build Docs",
+            "detail": "Builds the docs into a self-contained set of HTML files using Sphinx",
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": [
+                "run", "--extra", "doc",
+                "sphinx-build", "-T", "-E",
+                "${workspaceFolder}/docs",
+                "${workspaceFolder}/.docs_build"
+            ],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },
         {
-            "label": "Build Package",
+            "label": "Auto Build Docs",
+            "detail": "Runs the Sphinx documentation server on localhost:9999 with live reloading.",
+            "type": "process",
+            "problemMatcher": [],
             "command": "uv",
-            "args": ["build"],
-            "type": "shell",
+            "args": [
+                "run", "--extra", "doc",
+                "sphinx-autobuild", "-T", "-E",
+                "${workspaceFolder}/docs",
+                "${workspaceFolder}/.docs_build",
+                "--port", "9999",
+                "--watch", "${workspaceFolder}/appdaemon",
+                "--watch", "${workspaceFolder}/tests",
+            ],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },
         {
             "label": "Build Runtime Requirements",
-            "command": "uv",
-            "args": ["pip", "compile", "--resolver=backtracking",  "--upgrade", "pyproject.toml"],
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": ["pip", "compile", "--upgrade", "pyproject.toml"],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "group": "requirements",
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },
         {
             "label": "Build Dev Requirements",
-            "command": "uv",
-            "args": ["pip", "compile", "--extra=dev", "--output-file=dev-requirements.txt", "--resolver=backtracking",  "--upgrade", "pyproject.toml"],
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": [
+                "pip", "compile",
+                "--extra=dev",
+                "--output-file=dev-requirements.txt",
+                "--upgrade", "pyproject.toml"
+            ],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "group": "requirements",
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },
         {
             "label": "Build Doc Requirements",
-            "command": "uv",
-            "args": ["pip", "compile", "--extra=doc", "--output-file=doc-requirements.txt", "--resolver=backtracking", "--upgrade", "pyproject.toml"],
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": [
+                "pip", "compile",
+                "--extra=doc",
+                "--output-file=doc-requirements.txt",
+                "--upgrade", "pyproject.toml"
+            ],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "group": "requirements",
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },
         {
-            "label": "Build All Requirements",
-            "dependsOn": ["Build Runtime Requirements", "Build Dev Requirements", "Build Doc Requirements"]
+            "label": "Build All Requirements Files",
+            "detail": "Resolves all the dependencies into requirements files.",
+            "dependsOn": ["Build Runtime Requirements", "Build Dev Requirements", "Build Doc Requirements"],
+            "problemMatcher": [],
         },
         {
             "label": "Install Dependencies",
-            "command": "pip",
-            "args": ["install", "-r", "requirements.txt", "-r", "doc-requirements.txt", "-r", "dev-requirements.txt"],
+            "detail": "Installs all the dependencies, including dev and doc extras",
             "type": "shell",
+            "problemMatcher": [],
+            "command": "uv",
+            "args": ["sync", "--all-extras"],
             "presentation":
                 {
                     "echo": true,
                     "reveal": "always",
                     "focus": false,
                     "panel": "shared",
-                    "showReuseMessage": false,
+                    "showReuseMessage": true,
                     "clear": true
                 },
         },