updates2mqtt 1.4.1__tar.gz → 1.5.0__tar.gz

updates2mqtt-1.5.0/.github/workflows/auto_assign_issue.yml

@@ -0,0 +1,18 @@
+name: Issue assignment
+
+on:
+    issues:
+        types: [opened]
+
+jobs:
+    auto-assign:
+        runs-on: ubuntu-latest
+        permissions:
+            issues: write
+        steps:
+            - name: 'Auto-assign issue'
+              uses: pozil/auto-assign-issue@39c06395cbac76e79afc4ad4e5c5c6db6ecfdd2e
+              with:
+                  assignees: jeyrb
+                  numOfAssignee: 1
+                  allowSelfAssign: true

updates2mqtt-1.5.0/.github/workflows/auto_assign_pr.yml

@@ -0,0 +1,18 @@
+name: PR assignment
+
+on:
+    pull_request:
+        types: [opened, edited, synchronize, reopened]
+
+jobs:
+    auto-assign:
+        runs-on: ubuntu-latest
+        permissions:
+            pull-requests: write
+        steps:
+            - name: 'Auto-assign PR'
+              uses: pozil/auto-assign-issue@39c06395cbac76e79afc4ad4e5c5c6db6ecfdd2e
+              with:
+                  repo-token: ${{ secrets.MY_PERSONAL_ACCESS_TOKEN }}
+                  assignees: jeyrb
+                  numOfAssignee: 1

updates2mqtt-1.5.0/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Issue assignment
+
+on:
+    issues:
+        types: [opened]
+
+jobs:
+    auto-assign:
+        runs-on: ubuntu-latest
+        permissions:
+            issues: write
+        steps:
+            - name: 'Auto-assign issue'
+              uses: pozil/auto-assign-issue@v2
+              with:
+                  assignees: jeyrb
+                  numOfAssignee: 1
+                  allowSelfAssign: true

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/.pre-commit-config.yaml

@@ -17,11 +17,11 @@ repos:
       - id: check-shebang-scripts-are-executable
         name: Check shell scripts are executable
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.9.13
+    rev: 0.9.16
     hooks:
       - id: uv-lock
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.7
+    rev: v0.14.8
     hooks:
      # Run the linter.
       - id: ruff-check

updates2mqtt-1.5.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# CHANGELOG
+
+## 1.5.0
+- Target specific service on docker compose commands, where available from `com.docker.compose.service` label
+- Log level in config is now an enum, and forced to be upper case
+- Removed unnecessary latest_version fields from config message, which also saves a redundant MQTT subscription
+- Publication of `command_topic` for each discovery can now be forced with `force_command_topic` option
+- More common packages: docker:cli
+- Common packages can now match on the image ref rather than base name, for example `docker:cli`
+- Reduced log noise in INFO and increased logging detail for DEBUG
+- Common Packages now allow entries without all the values, initially `rtl_433` which lacks a logo
+## 1.4.2
+- Replace `origin` in config MQTT message with `device` for better HomeAssistant compatibility
+- An `area` can be defined in the Home Assistant section of config and this will then be used as `suggested_area` for device
+- Icon and release note info added for Owntone, Nextcloud, n8n, and Homarr
+- More testcases
+## 1.4.1
+- More logging for Docker discovery on why Home Assistant doesn't show an update button
+- More test cases
+- `MqttClient` is now `MqttPublisher` to avoid confusion with actual MQTT client
+- Task cleanup now only interrupts explicit list of tasks - healthcheck and discovery tasks
+## 1.4.0
+- MQTT protocol can now be set, to one of `3.1`,`3.11` or `5`
+- Debug messages now provided for `on_subscribe` and `on_unsubscribe` callbacks
+- Troubleshooting, installation, configuration docs updated, images optimized
+
+## 1.3.7
+- Improved initial setup when run without config or env vars for MQTT
+- Minor test deps update and pyproject docs
+
+## 1.3.6
+- Changed exit code on graceful shutdown to 143
+- App now exits if the MQTT username / password is not authorized
+- Improved handling of env vars, default config now assumes MQTT_HOST etc unless overridden
+  - Will now run without a config if correct `MQTT_HOST`,`MQTT_USER`,`MQTT_PASS`,`MQTT_PORT` env vars set or match the defaults (`127.0.0.1:1883`)
+- Deps update

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.4.1
+Version: 1.5.0
 Summary: System update and docker image notification and execution over MQTT
 Project-URL: Homepage, https://updates2mqtt.rhizomatics.org.uk
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
@@ -35,7 +35,7 @@ Requires-Dist: structlog>=25.4.0
 Requires-Dist: usingversion>=0.1.2
 Description-Content-Type: text/markdown
 
-[![Rhizomatics Open Source](https://avatars.githubusercontent.com/u/162821163?s=96&v=4)](https://github.com/rhizomatics)
+![updates2mqtt](images/updates2mqtt-dark-256x256.png){ align=left }
 
 # updates2mqtt
 
@@ -43,14 +43,19 @@ Description-Content-Type: text/markdown
 
 [![PyPI - Version](https://img.shields.io/pypi/v/updates2mqtt)](https://pypi.org/project/updates2mqtt/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
-![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/coverage.svg)
-![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/tests.svg)
+[![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/coverage.svg)](https://updates2mqtt.rhizomatics.org.uk/developer/coverage/)
+![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/tests.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
 [![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
 [![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)
 [![CodeQL](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql)
 [![Dependabot Updates](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates)
 
+
+<br/>
+<br/>
+
+
 ## Summary
 
 Let Home Assistant tell you about new updates to Docker images for your containers.
@@ -86,15 +91,17 @@ Presently only Docker containers are supported, although others are planned, pro
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |
   
-## Healthcheck
+## Heartbeat
 
 A heartbeat JSON payload is optionally published periodically to a configurable MQTT topic, defaulting to `healthcheck/{node_name}/updates2mqtt`. It contains the current version of updates2mqtt, the node name, a timestamp, and some basic stats.
 
+## Healthcheck
+
 A `healthcheck.sh` script is included in the Docker image, and can be used as a Docker healthcheck, if the container environment variables are set for `MQTT_HOST`, `MQTT_PORT`, `MQTT_USER` and `MQTT_PASS`. It uses the `mosquitto-clients` Linux package which provides `mosquitto_sub` command to subscribe to topics.
 
 !!! tip
 
-    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
+    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq` (can omit `| jq` if you don't have jsonquery installed, but much easier to read with it)
 
 Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
 

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/README.md

@@ -1,4 +1,4 @@
-[![Rhizomatics Open Source](https://avatars.githubusercontent.com/u/162821163?s=96&v=4)](https://github.com/rhizomatics)
+![updates2mqtt](images/updates2mqtt-dark-256x256.png){ align=left }
 
 # updates2mqtt
 
@@ -6,14 +6,19 @@
 
 [![PyPI - Version](https://img.shields.io/pypi/v/updates2mqtt)](https://pypi.org/project/updates2mqtt/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
-![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/coverage.svg)
-![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/tests.svg)
+[![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/coverage.svg)](https://updates2mqtt.rhizomatics.org.uk/developer/coverage/)
+![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/tests.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
 [![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
 [![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)
 [![CodeQL](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql)
 [![Dependabot Updates](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates)
 
+
+<br/>
+<br/>
+
+
 ## Summary
 
 Let Home Assistant tell you about new updates to Docker images for your containers.
@@ -49,15 +54,17 @@ Presently only Docker containers are supported, although others are planned, pro
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |
   
-## Healthcheck
+## Heartbeat
 
 A heartbeat JSON payload is optionally published periodically to a configurable MQTT topic, defaulting to `healthcheck/{node_name}/updates2mqtt`. It contains the current version of updates2mqtt, the node name, a timestamp, and some basic stats.
 
+## Healthcheck
+
 A `healthcheck.sh` script is included in the Docker image, and can be used as a Docker healthcheck, if the container environment variables are set for `MQTT_HOST`, `MQTT_PORT`, `MQTT_USER` and `MQTT_PASS`. It uses the `mosquitto-clients` Linux package which provides `mosquitto_sub` command to subscribe to topics.
 
 !!! tip
 
-    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
+    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq` (can omit `| jq` if you don't have jsonquery installed, but much easier to read with it)
 
 Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
 

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/common_packages.yaml

@@ -3,7 +3,7 @@ common_packages:
     docker:
       image_name: ghcr.io/rhizomatics/updates2mqtt
     logo_url: https://avatars.githubusercontent.com/u/162821163?s=48&v=4
-    release_notes_url: https://github.com/rhizomatics/updates2mqtt/pkgs/container/updates2mqtt
+    release_notes_url: https://github.com/rhizomatics/updates2mqtt/releases
 
   frigate:
     docker:
@@ -26,7 +26,7 @@ common_packages:
   caddy:
     docker:
       image_name: caddy
-    logo_url: https://d1q6f0aelx0por.cloudfront.net/product-logos/library-caddy-logo.png
+    logo_url: https://avatars.githubusercontent.com/u/12955528?s=48&v=4
     release_notes_url: https://github.com/caddyserver/caddy/releases
 
   uptime-kuma:
@@ -81,4 +81,39 @@ common_packages:
     docker:
       image_name: jellyfin/jellyfin
     logo_url: https://avatars.githubusercontent.com/u/45698031?s=48&v=4
-    release_notes_url: https://github.com/jellyfin/jellyfin/releases
+    release_notes_url: https://github.com/jellyfin/jellyfin/releases
+
+  owntone:
+    docker:
+      image_name: owntone/owntone
+    logo_url: https://raw.githubusercontent.com/owntone/owntone-server/443fb684871e005a7e442a08cc4d610208abbe6c/docs/assets/logo.svg
+    release_notes_url: https://github.com/owntone/owntone-server/releases
+
+  homarr:
+    docker:
+      image_name: ghcr.io/homarr-labs/homarr
+    logo_url: https://github.com/homarr-labs/homarr/blob/dev/docs/img/logo/2340450-2-title.png?raw=true
+    release_notes_url: https://github.com/homarr-labs/homarr/releases
+
+  nextcloud:
+    docker:
+      image_name: nextcloud
+    logo_url: https://avatars.githubusercontent.com/u/19211038?s=48&v=4
+    release_notes_url: https://github.com/nextcloud/docker/releases
+
+  n8n:
+    docker:
+      image_name: docker.n8n.io/n8nio/n8n
+    logo_url: https://avatars.githubusercontent.com/u/45487711?s=48&v=4
+    release_notes_url: https://github.com/n8n-io/n8n/releases
+
+  docker_cli:
+    docker:
+      image_name: docker:cli
+    logo_url: https://www.docker.com/app/uploads/2023/05/cli_1@2x.png
+    release_notes_url: https://github.com/docker-library/docker/commits/master/29/cli
+
+  rtl_433:
+    docker: 
+      image_name: hertzg/rtl_433
+    release_notes_url: https://github.com/merbanan/rtl_433/releases

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/conftest.py

@@ -35,7 +35,7 @@ def app_with_mocked_external_dependencies(
 
 @pytest.fixture
 def mock_discoveries(mock_provider: ReleaseProvider) -> list[Discovery]:
-    return [Discovery(mock_provider, "thing-1", "test001")]
+    return [Discovery(mock_provider, "thing-1", "test001", can_update=True)]
 
 
 @pytest.fixture

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/docs/examples/config_maximal.md

@@ -3,5 +3,5 @@
 More extensive example configuration, using all the features
 
 ``` yaml
---8<-- "examples/config.yaml.minimal"
+--8<-- "examples/config.yaml.maximal"
 ```

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/docs/examples/config_minimal.md

@@ -3,5 +3,5 @@
 Smallest working configuration
 
 ``` yaml
---8<-- "examples/config.yaml.maximal"
+--8<-- "examples/config.yaml.minimal"
 ```

updates2mqtt-1.5.0/docs/examples/docker_compose.md

@@ -0,0 +1,9 @@
+# Docker Compose
+
+Example Docker Compose configuration to run *updates2mqtt* as a container. This also
+requires a [.env](env.md), or alternatively adding the environment variables directly into the
+compose file.
+
+``` yaml
+--8<-- "examples/docker-compose.yaml"
+```

updates2mqtt-1.5.0/docs/examples/env.md

@@ -0,0 +1,7 @@
+# Environment File
+
+Example `.env` file for Docker Compose configuration to separately store the environment variables.
+
+``` bash
+--8<-- "examples/.env"
+```

updates2mqtt-1.5.0/docs/examples/index.md

@@ -0,0 +1,5 @@
+# Example Configurations
+
+Configuration files and Docker Compose files.
+
+{{ pagetree(siblings) }}

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/docs/home_assistant.md

@@ -16,16 +16,33 @@ The `homeassistant` default topic prefix matches the default updates2mqtt config
 
 ![Home Assistant updates in Settings](images/ha_update_page.png "Home Assistant Updates")
 
+## Device Creation
+
+A Home Assistant device will be created for each Updates2MQTT agent on each server, and Home Assistant
+will then group all the relevant entities together on this device page. Use `device_creation: false` in the 
+`homeassistant` config block if you want to switch off this behaviour, and `area` if you want to provide
+a `suggested_area` for the device.
+
 ## MQTT Topics
 
 There are 3 separate types of MQTT topic used for HomeAssisstant integration:
 
-- *Config* to support auto discovery. A topic is created per component, with a name like `homeassistant/update/dockernuc_docker_jellyfin/update/config`. This can be disabled in the config file, and the `homeassistant` topic prefix can also be configured.
-- *State* to report the current version and the latest version available, again one topic per component, like `updates2mqtt/dockernuc/docker/jellyfin`.
-- *Command* to support triggering an update. These will be created on the fly by HomeAssistant when an update is requested, and updates2mqtt subscribes to pick up the changes, so you won't typically see these if browsing MQTT topics. Only one is needed per updates2mqtt agent, with a name like `updates2mqtt/dockernuc/docker`
+- *Config* to support auto discovery. 
+    - A topic is created per component, with a name like `homeassistant/update/dockernuc_docker_jellyfin/update/config`. 
+    - This can be disabled in the config file, and the `homeassistant` topic prefix can also be configured.
+- *State* to report the current version and the latest version available
+    - One topic per component, like `updates2mqtt/dockernuc/docker/jellyfin`.
+- *Command* to support triggering an update. 
+    - These will be created on the fly by HomeAssistant when an update is requested
+    - Updates2mqtt subscribes to pick up the changes, so you won't typically see these if browsing MQTT topics. 
+    - Only one is needed per updates2mqtt agent, with a name like `updates2mqtt/dockernuc/docker`
 
 If the package supports automated update, then *Skip* and *Install* buttons will appear on the Home Assistant interface, and the package can be remotely fetched and the component restarted.
 
+If it doesn't support automated update, the `command_topic` won't be published with the configuration
+message, unless `force_command_topic` is set to `true` in the `homeassistant` configuration section,
+this will force the Home Assistant app to show the update, but with a do-nothing Update button.
+
 ## More Home Assistant information
 
 - [MQTT Integration](https://www.home-assistant.io/integrations/mqtt/)

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/docs/installation.md

@@ -20,13 +20,14 @@ volumes:
       - /var/run/docker.sock:/var/run/docker.sock
       # This list of paths is only needed when containers are to be updated
       # The paths here are completely dependent on where your docker-compose files live
-      - /home/containers:/home/containers
-      - /dev.containers:/dev.containers
-      - /containers:/containers
+      # and the internal/external paths must be exactly the same
+      - /my/container/home:/my/container/home
+      - /more/containers:/more/containers
 ```
 
-The example `docker-compose.yaml` mounts `/home/containers` for this purpose, so if your containers are in
-`/home/containers/app1`, `/home/containers/app2` etc, then updates2mqtt will be able to find them. Map as many root paths as needed.
+The example `docker-compose.yaml` mounts `/my/container/home` for this purpose, so if your containers are in
+`/my/container/home/app1`, `/my/container/home/app2` etc, then updates2mqtt will be able to find them in
+order to restart them. Map as many root paths as needed.
 
 ### Without Docker
 

updates2mqtt-1.5.0/docs/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://updates2mqtt.rhizomatics.org.uk/sitemap.xml

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/docs/troubleshooting.md

@@ -1,3 +1,11 @@
+---
+tags:
+  - docker
+  - docker-compose
+  - homeassistant
+  - mqtt
+  - paho
+---
 # Troubleshooting
 
 ## General

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/examples/config.yaml.maximal

@@ -19,6 +19,9 @@ homeassistant:
     prefix: homeassistant
     enabled: true
   state_topic_suffix: state
+  area: Server Room
+  device_creation: true
+  force_command_topic: false
 docker:
   enabled: true
   allow_pull: true

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/examples/docker-compose.yaml

@@ -5,7 +5,7 @@ services:
     volumes:
       - ./conf:/app/conf  # Config file lives at /app/conf/config.yaml inside the container
       - /var/run/docker.sock:/var/run/docker.sock # Access to Docker daemon for container updates
-      - /home/containers:/home/containers # Optional, map all root paths for docker compose directories
+      - /my/container/home:/my/container/home # Optional, map all root paths for docker compose directories
     restart: always
     env_file: ./.env  # Environment variables file
     healthcheck:

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/mkdocs.yml

@@ -4,13 +4,18 @@ site_description: Notify and take action on server updates via MQTT, with HomeAs
 
 repo_name: rhizomatics/updates2mqtt
 repo_url: https://github.com/rhizomatics/updates2mqtt
+edit_uri: edit/main/docs/
 
 theme:
   name: material
   highlightjs: true
-  logo: images/logo-blank-256x256.png
+  logo: images/updates2mqtt-dark-256x256.png
   language: en
+  icon:
+    repo: fontawesome/brands/github
   features:
+    - content.action.edit
+    - content.action.view
     - content.code.copy
     - content.code.select
     - content.code.annotate 
@@ -24,14 +29,24 @@ theme:
     - navigation.top
     - toc.follow
     - toc.integrate
+    - search.suggest
+    - search
+    - search.share
 plugins:
   - search
   - autorefs
   - pagetree
   - optimize
-  - tags
+  - tags:
+      tags: false
+  - git-revision-date-localized:
+      enable_creation_date: true
+  - meta-descriptions
   - minify:
       minify_html: true
+  - coverage:
+      page_path: developer/coverage
+      html_report_dir: htmlcov
   - mkdocstrings:
       handlers:
         # See: https://mkdocstrings.github.io/python/usage/
@@ -40,6 +55,10 @@ plugins:
             show_source: false
             show_root_heading: true
             summary: true
+            show_inheritance_diagram: false
+            overloads_only: true
+            show_if_no_docstring: false
+
 markdown_extensions:
   - admonition
   - pymdownx.details
@@ -52,7 +71,6 @@ markdown_extensions:
       pygments_lang_class: true
   - pymdownx.inlinehilite
   - pymdownx.superfences
-  - admonition
   - smarty
   - toc:
       permalink: true

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 
 requires-python = ">=3.13"
-version = "1.4.1"
+version = "1.5.0"
 license="Apache-2.0"
 keywords=["mqtt", "docker", "updates", "automation","home-assistant","homeassistant","selfhosting"]
 
@@ -60,14 +60,16 @@ dev = [
     "genbadge[all]"
 ]
 mkdocs=[
+    "mkdocs",
     "mkdocs-material",
-    "mkdocstrings",
     "mkdocs-minify-plugin",
     "mkdocs-autorefs",
     "mkdocs-pagetree-plugin",
     "mkdocs-coverage",
     "mkdocstrings[python]",
     "pymdown-extensions",
+    "mkdocs-git-revision-date-localized-plugin",
+    "mkdocs-meta-descriptions-plugin",
     "pngquant"
 ]
 

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/scripts/healthcheck.sh

@@ -2,6 +2,11 @@
 
 # MQTT Health Check Script
 # Checks if the heartbeat timestamp in MQTT payload is recent enough
+# Requires MQTT connection details to be available as environment variables
+#   - MQTT_HOST (defaults to localhost)
+#   - MQTT_PORT (defaults to 1883)
+#   - MQTT_USER (no default)
+#   - MQTT_PASS (no default)
 
 # Arguments
 MQTT_TOPIC=$1

{updates2mqtt-1.4.1 → updates2mqtt-1.5.0}/src/updates2mqtt/app.py

@@ -14,7 +14,7 @@ import structlog
 import updates2mqtt
 from updates2mqtt.model import Discovery, ReleaseProvider
 
-from .config import Config, load_app_config, load_package_info
+from .config import Config, PackageUpdateInfo, load_app_config, load_package_info
 from .integrations.docker import DockerProvider
 from .mqtt import MqttPublisher
 
@@ -44,9 +44,9 @@ class App:
             sys.exit(1)
         self.cfg: Config = app_config
 
-        structlog.configure(wrapper_class=structlog.make_filtering_bound_logger(getattr(logging, self.cfg.log.level)))
+        structlog.configure(wrapper_class=structlog.make_filtering_bound_logger(getattr(logging, str(self.cfg.log.level))))
         log.debug("Logging initialized", level=self.cfg.log.level)
-        self.common_pkg = load_package_info(PKG_INFO_FILE)
+        self.common_pkg: dict[str, PackageUpdateInfo] = load_package_info(PKG_INFO_FILE)
 
         self.publisher = MqttPublisher(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
 
@@ -62,25 +62,29 @@ class App:
             "App configured",
             node=self.cfg.node.name,
             scan_interval=self.cfg.scan_interval,
+            healthcheck_topic=self.healthcheck_topic,
         )
 
     async def scan(self) -> None:
         session = uuid.uuid4().hex
         for scanner in self.scanners:
-            log.info("Cleaning topics before scan", source_type=scanner.source_type)
+            slog = log.bind(source_type=scanner.source_type, session=session)
+            slog.info("Cleaning topics before scan")
             if self.scan_count == 0:
                 await self.publisher.clean_topics(scanner, None, force=True)
             if self.stopped.is_set():
                 break
-            log.info("Scanning", source=scanner.source_type, session=session)
+            slog.info("Scanning ...")
             async with asyncio.TaskGroup() as tg:
-                async for discovery in scanner.scan(session):  # xtype: ignore[attr-defined]
+                # xtype: ignore[attr-defined]
+                async for discovery in scanner.scan(session):
                     tg.create_task(self.on_discovery(discovery), name=f"discovery-{discovery.name}")
             if self.stopped.is_set():
+                slog.debug("Breaking scan loop on stopped event")
                 break
             await self.publisher.clean_topics(scanner, session, force=False)
             self.scan_count += 1
-            log.info("Scan complete", source_type=scanner.source_type)
+            slog.info(f"Scan #{self.scan_count} complete")
         self.last_scan_timestamp = datetime.now(UTC).isoformat()
 
     async def main_loop(self) -> None:
@@ -170,13 +174,15 @@ class App:
     async def healthcheck(self) -> None:
         if not self.publisher.is_available():
             return
+        heartbeat_stamp: str = datetime.now(UTC).isoformat()
+        log.debug("Publishing health check", heartbeat_stamp=heartbeat_stamp)
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
                 "version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
                 "node": self.cfg.node.name,
                 "heartbeat_raw": time.time(),
-                "heartbeat_stamp": datetime.now(UTC).isoformat(),
+                "heartbeat_stamp": heartbeat_stamp,
                 "startup_stamp": self.startup_timestamp,
                 "last_scan_stamp": self.last_scan_timestamp,
                 "scan_count": self.scan_count,
@@ -191,7 +197,7 @@ async def repeated_call(func: Callable, interval: int = 60, *args: Any, **kwargs
             await func(*args, **kwargs)
             await asyncio.sleep(interval)
         except asyncio.CancelledError:
-            log.debug("Periodic task cancelled")
+            log.debug("Periodic task cancelled", func=func)
         except Exception:
             log.exception("Periodic task failed")
 
@@ -202,6 +208,7 @@ def run() -> None:
 
     from .app import App
 
+    # pyright: ignore[reportAttributeAccessIssue]
     log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")  # pyright: ignore[reportAttributeAccessIssue]
     app = App()