updates2mqtt 1.7.0__py3-none-any.whl → 1.7.2__py3-none-any.whl

updates2mqtt/integrations/git_utils.py

@@ -44,7 +44,7 @@ def git_iso_timestamp(repo_path: Path, git_path: Path) -> str | None:
     return None
 
 
-def git_local_version(repo_path: Path, git_path: Path) -> str | None:
+def git_local_digest(repo_path: Path, git_path: Path) -> str | None:
     result = None
     try:
         result = subprocess.run(
@@ -56,17 +56,17 @@ def git_local_version(repo_path: Path, git_path: Path) -> str | None:
             check=True,
         )
         if result.returncode == 0:
-            log.debug("Local git rev-parse", action="git_local_version", path=repo_path, version=result.stdout.strip())
-            return f"git:{result.stdout.strip()}"[:19]
+            log.debug("Local git rev-parse", action="git_local_digest", path=repo_path, version=result.stdout.strip())
+            return result.stdout.strip()[:15]
     except subprocess.CalledProcessError as cpe:
-        log.warn("GIT No result from git rev-parse at %s: %s", repo_path, cpe, action="git_local_version")
+        log.warn("GIT No result from git rev-parse at %s: %s", repo_path, cpe, action="git_local_digest")
     except Exception as e:
         log.error(
             "GIT Unable to retrieve version at %s - %s: %s",
             repo_path,
             result.stdout if result else "<NO RESULT>",
             e,
-            action="git_local_version",
+            action="git_local_digest",
         )
     return None
 

updates2mqtt/model.py

@@ -1,33 +1,63 @@
-import datetime as dt
 import json
-import re
 import time
 from abc import abstractmethod
 from collections.abc import AsyncGenerator, Callable
-from enum import StrEnum
 from threading import Event
 from typing import Any
 
 import structlog
-from tzlocal import get_localzone
 
-from updates2mqtt.config import NO_KNOWN_IMAGE, NodeConfig, PublishPolicy, Selector, UpdatePolicy
+from updates2mqtt.config import NodeConfig, PublishPolicy, UpdatePolicy, VersionPolicy
+from updates2mqtt.helpers import timestamp
 
 
-def timestamp(time_value: float | None) -> str | None:
-    if time_value is None:
-        return None
-    try:
-        return dt.datetime.fromtimestamp(time_value, tz=get_localzone()).isoformat()
-    except:  # noqa: E722
-        return None
+class DiscoveryArtefactDetail:
+    """Provider specific detail"""
 
+    def as_dict(self) -> dict[str, str | list | dict | bool | int | None]:
+        return {}
+
+
+class DiscoveryInstallationDetail:
+    """Provider specific detail"""
+
+    @abstractmethod
+    def as_dict(self) -> dict[str, str | list | dict | bool | int | None]:
+        return {}
 
-class VersionPolicy(StrEnum):
-    AUTO = "AUTO"
-    VERSION = "VERSION"
-    DIGEST = "DIGEST"
-    VERSION_DIGEST = "VERSION_DIGEST"
+
+class ReleaseDetail:
+    """The artefact source details
+
+    Note this may be an actual software package, or the source details of the wrapping of it
+    For example, some Docker images report the main source repo, and others where the Dockerfile deploy project lives
+    """
+
+    def __init__(self, notes_url: str | None = None, summary: str | None = None) -> None:
+        self.source_platform: str | None = None
+        self.source_repo_url: str | None = None
+        self.source_url: str | None = None
+        self.version: str | None = None
+        self.revision: str | None = None
+        self.diff_url: str | None = None
+        self.notes_url: str | None = notes_url
+        self.title: str | None = None
+        self.summary: str | None = summary
+        self.net_score: int | None = None
+
+    def as_dict(self) -> dict[str, str | None]:
+        return {
+            "title": self.title,
+            "version": self.version,
+            "source_platform": self.source_platform,
+            "source_repo": self.source_repo_url,
+            "source": self.source_url,
+            "revision": self.revision,
+            "diff_url": self.diff_url,
+            "notes_url": self.notes_url,
+            "summary": self.summary,
+            "net_score": str(self.net_score) if self.net_score is not None else None,
+        }
 
 
 class Discovery:
@@ -42,22 +72,24 @@ class Discovery:
         entity_picture_url: str | None = None,
         current_version: str | None = None,
         latest_version: str | None = None,
-        can_update: bool = False,
         can_build: bool = False,
         can_restart: bool = False,
+        can_pull: bool = False,
         status: str = "on",
         publish_policy: PublishPolicy = PublishPolicy.HOMEASSISTANT,
         update_type: str | None = "Update",
         update_policy: UpdatePolicy = UpdatePolicy.PASSIVE,
         version_policy: VersionPolicy = VersionPolicy.AUTO,
-        release_url: str | None = None,
-        release_summary: str | None = None,
+        version_basis: str | None = None,
         title_template: str = "{discovery.update_type} for {discovery.name} on {discovery.node}",
         device_icon: str | None = None,
         custom: dict[str, Any] | None = None,
-        features: list[str] | None = None,
         throttled: bool = False,
         previous: "Discovery|None" = None,
+        release_detail: ReleaseDetail | None = None,
+        installation_detail: DiscoveryInstallationDetail | None = None,
+        current_detail: DiscoveryArtefactDetail | None = None,
+        latest_detail: DiscoveryArtefactDetail | None = None,
     ) -> None:
         self.provider: ReleaseProvider = provider
         self.source_type: str = provider.source_type
@@ -67,11 +99,9 @@ class Discovery:
         self.entity_picture_url: str | None = entity_picture_url
         self.current_version: str | None = current_version
         self.latest_version: str | None = latest_version
-        self.can_update: bool = can_update
+        self.can_pull: bool = can_pull
         self.can_build: bool = can_build
         self.can_restart: bool = can_restart
-        self.release_url: str | None = release_url
-        self.release_summary: str | None = release_summary
         self.title_template: str | None = title_template
         self.device_icon: str | None = device_icon
         self.update_type: str | None = update_type
@@ -79,13 +109,18 @@ class Discovery:
         self.publish_policy: PublishPolicy = publish_policy
         self.update_policy: UpdatePolicy = update_policy
         self.version_policy: VersionPolicy = version_policy
+        self.version_basis: str | None = version_basis
         self.update_last_attempt: float | None = None
         self.custom: dict[str, Any] = custom or {}
-        self.features: list[str] = features or []
         self.throttled: bool = throttled
         self.scan_count: int
         self.first_timestamp: float
         self.last_timestamp: float = time.time()
+        self.check_timestamp: float | None = time.time()
+        self.release_detail: ReleaseDetail | None = release_detail
+        self.current_detail: DiscoveryArtefactDetail | None = current_detail
+        self.latest_detail: DiscoveryArtefactDetail | None = latest_detail
+        self.installation_detail: DiscoveryInstallationDetail | None = installation_detail
 
         if previous:
             self.update_last_attempt = previous.update_last_attempt
@@ -94,6 +129,11 @@ class Discovery:
         else:
             self.first_timestamp = time.time()
             self.scan_count = 1
+        if throttled and previous:
+            # roll forward last non-throttled check
+            self.check_timestamp = previous.check_timestamp
+        elif not throttled:
+            self.check_timestamp = time.time()
 
     def __repr__(self) -> str:
         """Build a custom string representation"""
@@ -108,6 +148,21 @@ class Discovery:
         dump = {k: stringify(v) for k, v in self.__dict__.items()}
         return json.dumps(dump)
 
+    @property
+    def can_update(self) -> bool:
+        return self.can_pull or self.can_build or self.can_restart
+
+    @property
+    def features(self) -> list[str]:
+        results = []
+        if self.can_update:
+            # public install-neutral capabilities and Home Assistant features
+            results.append("INSTALL")
+            results.append("PROGRESS")
+        if self.release_detail and self.release_detail.notes_url:
+            results.append("RELEASE_NOTES")
+        return results
+
     @property
     def title(self) -> str:
         if self.title_template:
@@ -115,7 +170,7 @@ class Discovery:
         return self.name
 
     def as_dict(self) -> dict[str, str | list | dict | bool | int | None]:
-        return {
+        results: dict[str, str | list | dict | bool | int | None] = {
             "name": self.name,
             "node": self.node,
             "provider": {"source_type": self.provider.source_type},
@@ -124,10 +179,8 @@ class Discovery:
             "scan_count": self.scan_count,
             "installed_version": self.current_version,
             "latest_version": self.latest_version,
+            "version_basis": self.version_basis,
             "title": self.title,
-            "release_summary": self.release_summary,
-            "release_url": self.release_url,
-            "entity_picture_url": self.entity_picture_url,
             "can_update": self.can_update,
             "can_build": self.can_build,
             "can_restart": self.can_restart,
@@ -135,12 +188,20 @@ class Discovery:
             "update_type": self.update_type,
             "status": self.status,
             "features": self.features,
-            "update_policy": self.update_policy,
-            "publish_policy": self.publish_policy,
-            "version_policy": self.version_policy,
+            "entity_picture_url": self.entity_picture_url,
+            "update_policy": str(self.update_policy),
+            "publish_policy": str(self.publish_policy),
+            "version_policy": str(self.version_policy),
             "update": {"last_attempt": timestamp(self.update_last_attempt), "in_progress": False},
-            self.source_type: self.custom,
+            "installation_detail": self.installation_detail.as_dict() if self.installation_detail else None,
+            "current_detail": self.current_detail.as_dict() if self.current_detail else None,
+            "latest_detail": self.latest_detail.as_dict() if self.latest_detail else None,
         }
+        if self.release_detail:
+            results["release"] = self.release_detail.as_dict() if self.release_detail else None
+        if self.custom:
+            results[self.source_type] = self.custom
+        return results
 
 
 class ReleaseProvider:
@@ -188,59 +249,3 @@ class ReleaseProvider:
     @abstractmethod
     def resolve(self, discovery_name: str) -> Discovery | None:
         """Resolve a discovered component by name"""
-
-
-class Selection:
-    def __init__(self, selector: Selector, value: str | None) -> None:
-        self.result: bool = True
-        self.matched: str | None = None
-        if value is None:
-            self.result = selector.include is None
-            return
-        if selector.exclude is not None:
-            self.result = True
-            if any(re.search(pat, value) for pat in selector.exclude):
-                self.matched = value
-                self.result = False
-        if selector.include is not None:
-            self.result = False
-            if any(re.search(pat, value) for pat in selector.include):
-                self.matched = value
-                self.result = True
-
-
-VERSION_RE = r"[vV]?[0-9]+(\.[0-9]+)*"
-
-
-def select_version(
-    version_policy: VersionPolicy,
-    version: str | None,
-    digest: str | None,
-    other_version: str | None = None,
-    other_digest: str | None = None,
-) -> str:
-    if version_policy == VersionPolicy.VERSION and version:
-        return version
-    if version_policy == VersionPolicy.DIGEST and digest and digest != NO_KNOWN_IMAGE:
-        return digest
-    if version_policy == VersionPolicy.VERSION_DIGEST and version and digest and digest != NO_KNOWN_IMAGE:
-        return f"{version} ({digest})"
-    # AUTO or fallback
-    if version_policy == VersionPolicy.AUTO and version and re.match(VERSION_RE, version or ""):
-        # Smells like semver
-        if other_version is None and other_digest is None:
-            return version
-        if re.match(VERSION_RE, other_version or "") and (
-            (version == other_version and digest == other_digest) or (version != other_version and digest != other_digest)
-        ):
-            # Only semver if versions and digest consistently same or different
-            return version
-
-    if version and digest and digest != NO_KNOWN_IMAGE:
-        return f"{version}:{digest}"
-    if version:
-        return version
-    if digest and digest != NO_KNOWN_IMAGE:
-        return digest
-
-    return other_version or other_version or NO_KNOWN_IMAGE

updates2mqtt/mqtt.py

@@ -203,6 +203,7 @@ class MqttPublisher:
     async def execute_command(
         self, msg: MQTTMessage | LocalMessage, on_update_start: Callable, on_update_end: Callable
     ) -> None:
+        # TODO: defer handling of commands where repository is throttled
         logger = self.log.bind(topic=msg.topic, payload=msg.payload)
         comp_name: str | None = None
         command: str | None = None
@@ -235,6 +236,8 @@ class MqttPublisher:
                 updated = provider.command(comp_name, command, on_update_start, on_update_end)
                 discovery = provider.resolve(comp_name)
                 if updated and discovery:
+                    if discovery.publish_policy == PublishPolicy.HOMEASSISTANT and self.hass_cfg.discovery.enabled:
+                        self.publish_hass_config(discovery)
                     if discovery.publish_policy in (PublishPolicy.HOMEASSISTANT, PublishPolicy.MQTT):
                         self.publish_discovery(discovery)
                     if discovery.publish_policy == PublishPolicy.HOMEASSISTANT:
@@ -337,6 +340,8 @@ class MqttPublisher:
         if discovery.publish_policy != PublishPolicy.HOMEASSISTANT:
             return
         object_id = f"{discovery.source_type}_{self.node_cfg.name}_{discovery.name}"
+        self.log.debug("HASS Config: %s", object_id)
+
         self.publish(
             self.config_topic(discovery),
             hass_format_config(

{updates2mqtt-1.7.0.dist-info → updates2mqtt-1.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.7.0
+Version: 1.7.2
 Summary: System update and docker image notification and execution over MQTT
 Keywords: mqtt,docker,oci,container,updates,automation,home-assistant,homeassistant,selfhosting
 Author: jey burrows
@@ -18,14 +18,14 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Typing :: Typed
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: docker>=7.1.0
 Requires-Dist: paho-mqtt>=2.1.0
 Requires-Dist: omegaconf>=2.3.0
 Requires-Dist: structlog>=25.4.0
 Requires-Dist: rich>=14.0.0
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: hishel[httpx]>=0.1.4
+Requires-Dist: hishel[httpx]>=1.1.0
 Requires-Dist: usingversion>=0.1.2
 Requires-Dist: tzlocal>=5.3.1
 Requires-Python: >=3.13
@@ -61,7 +61,7 @@ Description-Content-Type: text/markdown
 
 Let Home Assistant tell you about new updates to Docker images for your containers.
 
-![Example Home Assistant update page](images/ha_update_detail.png "Home Assistant Updates")
+![Example Home Assistant update page](images/ha_update_detail.png "Home Assistant Updates")![Example Home Assistant Release Notes](images/ha_release_notes.png "Home Assistant Release Notes"){width=300} 
 
 Read the release notes, and optionally click *Update* to trigger a Docker *pull* (or optionally *build*) and *update*.
 
@@ -72,7 +72,8 @@ Read the release notes, and optionally click *Update* to trigger a Docker *pull*
 
 Updates2MQTT perioidically checks for new versions of components being available, and publishes new version info to MQTT. HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's own components and add-ins.
 
-Currently only Docker containers are supported, either via an image registry check, or a git repo for source (see [Local Builds](local_builds.md)). The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
+Currently only Docker containers are supported, either via an image registry check (using either v1 Docker APIs or the OCI v2 API), or a git repo for source (see [Local Builds](local_builds.md)), with specific handling for Docker, Github Container Registry, Gitlab, Codeberg, Microsoft Container Registry and LinuxServer Registry, with adaptive behaviour to cope with most
+others.  The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
 
 Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install* button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience. See [Home Assistant Integration](home_assistant.md) for details.
 
@@ -81,7 +82,7 @@ To get started, read the [Installation](installation.md) and [Configuration](con
 For a quick spin, try this:
 
 ```bash
-docker run -v /var/run/docker.sock:/var/run/docker.sock -e MQTT_USER=user1 -e MQTT_PASS=user1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:release
+docker run -v /var/run/docker.sock:/var/run/docker.sock -e MQTT_USER=user1 -e MQTT_PASS=user1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:latest
 ```
 
 or without Docker, using [uv](https://docs.astral.sh/uv/)
@@ -159,6 +160,8 @@ The following environment variables can be used to configure containers for `upd
 | `UPD2MQTT_GIT_REPO_PATH`   | Relative path to a local git repo if the image is built locally.                             |                 |
 | `UPD2MQTT_IGNORE`          | If set to `True`, the container will be ignored by Updates2MQTT.                             | False           |
                         |                 |
+| `UPD2MQTT_VERSION_POLICY` | Change how version derived from container label or image hash, `Version`,`Digest`,`Version_Digest` with default of `Auto`|
+| `UPD2MQTT_REGISTRY_TOKEN` | Access token for authentication to container distribution API, as alternative to making a call to `token` service |
 
 ### Docker Labels
 
@@ -171,6 +174,9 @@ Alternatively, use Docker labels
 | `updates2mqtt.relnotes`        | `UPD2MQTT_RELNOTES`        |
 | `updates2mqtt.git_repo_path`   | `UPD2MQTT_GIT_REPO_PATH`   |
 | `updates2mqtt.ignore`          | `UPD2MQTT_IGNORE`          |
+| `updates2mqtt.version_policy`  | `UPD2MQTT_VERSION_POLICY`  |
+| `updates2mqtt.registry_token`  | `UPD2MQTT_REGISTRY_TOKEN`  |
+
 
 
 ```yaml title="Example Compose Snippet"
@@ -200,7 +206,7 @@ This component relies on several open source packages:
 - [Eclipse Paho](https://eclipse.dev/paho/files/paho.mqtt.python/html/client.html) MQTT client
 - [OmegaConf](https://omegaconf.readthedocs.io) for configuration and validation
 - [structlog](https://www.structlog.org/en/stable/) for structured logging and [rich](https://rich.readthedocs.io/en/stable/) for better exception reporting
-- [hishel](https://hishel.com/1.0/) for caching metadata
+- [hishel](https://hishel.com/) for caching metadata
 - [httpx](https://www.python-httpx.org) for retrieving metadata
 - The Astral [uv](https://docs.astral.sh/uv/) and [ruff](https://docs.astral.sh/ruff/) tools for development and build
 - [pytest](https://docs.pytest.org/en/stable/) and supporting add-ins for automated testing

updates2mqtt-1.7.2.dist-info/RECORD

@@ -0,0 +1,18 @@
+updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
+updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
+updates2mqtt/app.py,sha256=4OOzVTuOw5Zxrm6zppRG6kq7x6bOY6S0h44yRnoYoVk,9651
+updates2mqtt/cli.py,sha256=1ntGaJc8rOv8uU5l5oOCs80yey8A--CkHGPFYND0A6U,5237
+updates2mqtt/config.py,sha256=Yfr5tHTVj4Tl-Zpmx6UZ4HBOOFvdoIYXi91bUVgl8E0,7243
+updates2mqtt/hass_formatter.py,sha256=k0aLGg-7wI_C4TixhY-L-iz7n0QCKQ_Pvv37hSp22ww,2779
+updates2mqtt/helpers.py,sha256=fGGBA8JrneAji0AdqyA2waivV9Jq_rXB-CT6TzIFNZ8,9282
+updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
+updates2mqtt/integrations/docker.py,sha256=848AbaNiRGdIRi0nG9-_3JePBHy5d48ETDXilIf_emM,30171
+updates2mqtt/integrations/docker_enrich.py,sha256=1szsw7JpCWQcAG-rRp0KJ3Yj4MgE28C_RCKZngbnPv0,39474
+updates2mqtt/integrations/git_utils.py,sha256=AnMiVW-noaBQ-17FeIl93jwpTSzvr70nIDEcJN3D-gw,4356
+updates2mqtt/model.py,sha256=Pfwy2nSAq6-_ACEhZRsCVXlahTbDd07Ej2o_81SPdxc,10093
+updates2mqtt/mqtt.py,sha256=EYsWKGKzmwf3VIjQmf_oI2C962k3QTWJKXRnLC9kzEU,16687
+updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+updates2mqtt-1.7.2.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+updates2mqtt-1.7.2.dist-info/entry_points.txt,sha256=qtMKoTPaodbFC3YG7MLElWDjl7CfJdbrxxZyH6Bua8E,83
+updates2mqtt-1.7.2.dist-info/METADATA,sha256=7FEYhqFY1T77JJx54AsJ5GmtJDVydCHQm7g_IiMwraA,12131
+updates2mqtt-1.7.2.dist-info/RECORD,,

{updates2mqtt-1.7.0.dist-info → updates2mqtt-1.7.2.dist-info}/entry_points.txt

@@ -1,3 +1,4 @@
 [console_scripts]
+cli = updates2mqtt.cli:main
 updates2mqtt = updates2mqtt.app:run
 

updates2mqtt-1.7.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
-updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
-updates2mqtt/app.py,sha256=4OOzVTuOw5Zxrm6zppRG6kq7x6bOY6S0h44yRnoYoVk,9651
-updates2mqtt/config.py,sha256=Hulk-zynpWq6JUv_ftEY5tmY-Vr8tQU9vV8nuhKXmJ4,5936
-updates2mqtt/hass_formatter.py,sha256=xRm_iJiHU02v4KxNwps3V3g4dl_A7wNvQpLHCODzZlM,2690
-updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
-updates2mqtt/integrations/docker.py,sha256=GBYmzfzXuoI6j9GGIiDdq4KnR4677RCgzfxF6r4vTRM,28099
-updates2mqtt/integrations/docker_enrich.py,sha256=wdJOOvZw7gG5ncHy6BqeIc9vPhR94YJYa9dumLmh8SY,15279
-updates2mqtt/integrations/git_utils.py,sha256=ODCKecWnom1NEKsmDZ2vFmYfnVGtWUgq7svVGcOtSaU,4369
-updates2mqtt/model.py,sha256=MmWzHq8ibXYRVMLmATrmhMp05q3neAIkP8Q1OkEepBs,9264
-updates2mqtt/mqtt.py,sha256=KC8VYQ_OYiCoFehLT90dS5n8ZOZfffThapmQ29kyifE,16384
-updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-updates2mqtt-1.7.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-updates2mqtt-1.7.0.dist-info/entry_points.txt,sha256=Nt1kQQfJ1M2RvcRUnVxe3KCMiX8puHPqz-D7BwqV1L8,55
-updates2mqtt-1.7.0.dist-info/METADATA,sha256=POaF66x0AbR8qLJFyR3tDv27xRIbAu0Msyt2_o26TGU,11363
-updates2mqtt-1.7.0.dist-info/RECORD,,