updates2mqtt 1.6.0__tar.gz → 1.7.0__tar.gz

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.6.0
+Version: 1.7.0
 Summary: System update and docker image notification and execution over MQTT
-Keywords: mqtt,docker,updates,automation,home-assistant,homeassistant,selfhosting
+Keywords: mqtt,docker,oci,container,updates,automation,home-assistant,homeassistant,selfhosting
 Author: jey burrows
 Author-email: jey burrows <jrb@rhizomatics.org.uk>
 License-Expression: Apache-2.0
@@ -27,12 +27,13 @@ Requires-Dist: rich>=14.0.0
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: hishel[httpx]>=0.1.4
 Requires-Dist: usingversion>=0.1.2
+Requires-Dist: tzlocal>=5.3.1
 Requires-Python: >=3.13
-Project-URL: Changelog, https://github.com/rhizomatics/updates2mqtt/blob/main/CHANGELOG.md
-Project-URL: Documentation, https://updates2mqtt.rhizomatics.org.uk
 Project-URL: Homepage, https://updates2mqtt.rhizomatics.org.uk
-Project-URL: Issues, https://github.com/rhizomatics/updates2mqtt/issues
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
+Project-URL: Documentation, https://updates2mqtt.rhizomatics.org.uk
+Project-URL: Issues, https://github.com/rhizomatics/updates2mqtt/issues
+Project-URL: Changelog, https://github.com/rhizomatics/updates2mqtt/blob/main/CHANGELOG.md
 Description-Content-Type: text/markdown
 
 ![updates2mqtt](images/updates2mqtt-dark-256x256.png){ align=left }
@@ -132,7 +133,8 @@ file, or as `environment` options inside `docker-compose.yaml`.
 ### Automated updates
 
 If Docker containers should be immediately updated, without any confirmation
-or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE` in the target container to `Auto` ( it defaults to `Passive`)
+or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE` in the target container to `Auto` ( it defaults to `Passive`).  If you want it to update without publishing to MQTT and being
+visible to Home Assistant, then use `Silent`.
 
 ```yaml title="Example Compose Snippet"
 restarter:
@@ -142,9 +144,6 @@ restarter:
       - UPD2MQTT_UPDATE=AUTO
 ```
 
-This can be used in conjunction with the `UPD2MQTT_VERSION_INCLUDE` and `UPD2MQTT_VERSION_EXCLUDE` to
-limit which updates get automatically applied, for example excluding nightly builds.
-
 Automated updates can also apply to local builds, where a `git_repo_path` has been defined - if there are remote
 commits available to pull, then a `git pull`, `docker compose build` and `docker compose up` will be executed.
 
@@ -159,8 +158,7 @@ The following environment variables can be used to configure containers for `upd
 | `UPD2MQTT_RELNOTES`        | URL to release notes for the package.                                                        |                 |
 | `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_INCLUDE` | Only recognize versions matching this string or regular expression                           |                 |
-| `UPD2MQTT_VERSION_EXCLUDE` | Skip update if version matches this string or regular expression                             |                 |
+                        |                 |
 
 ### Docker Labels
 
@@ -173,8 +171,6 @@ Alternatively, use Docker labels
 | `updates2mqtt.relnotes`        | `UPD2MQTT_RELNOTES`        |
 | `updates2mqtt.git_repo_path`   | `UPD2MQTT_GIT_REPO_PATH`   |
 | `updates2mqtt.ignore`          | `UPD2MQTT_IGNORE`          |
-| `updates2mqtt.version_include` | `UPD2MQTT_VERSION_INCLUDE` |
-| `updates2mqtt.version_exclude` | `UPD2MQTT_VERSION_EXCLUDE` |
 
 
 ```yaml title="Example Compose Snippet"

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/README.md

@@ -95,7 +95,8 @@ file, or as `environment` options inside `docker-compose.yaml`.
 ### Automated updates
 
 If Docker containers should be immediately updated, without any confirmation
-or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE` in the target container to `Auto` ( it defaults to `Passive`)
+or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE` in the target container to `Auto` ( it defaults to `Passive`).  If you want it to update without publishing to MQTT and being
+visible to Home Assistant, then use `Silent`.
 
 ```yaml title="Example Compose Snippet"
 restarter:
@@ -105,9 +106,6 @@ restarter:
       - UPD2MQTT_UPDATE=AUTO
 ```
 
-This can be used in conjunction with the `UPD2MQTT_VERSION_INCLUDE` and `UPD2MQTT_VERSION_EXCLUDE` to
-limit which updates get automatically applied, for example excluding nightly builds.
-
 Automated updates can also apply to local builds, where a `git_repo_path` has been defined - if there are remote
 commits available to pull, then a `git pull`, `docker compose build` and `docker compose up` will be executed.
 
@@ -122,8 +120,7 @@ The following environment variables can be used to configure containers for `upd
 | `UPD2MQTT_RELNOTES`        | URL to release notes for the package.                                                        |                 |
 | `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_INCLUDE` | Only recognize versions matching this string or regular expression                           |                 |
-| `UPD2MQTT_VERSION_EXCLUDE` | Skip update if version matches this string or regular expression                             |                 |
+                        |                 |
 
 ### Docker Labels
 
@@ -136,8 +133,6 @@ Alternatively, use Docker labels
 | `updates2mqtt.relnotes`        | `UPD2MQTT_RELNOTES`        |
 | `updates2mqtt.git_repo_path`   | `UPD2MQTT_GIT_REPO_PATH`   |
 | `updates2mqtt.ignore`          | `UPD2MQTT_IGNORE`          |
-| `updates2mqtt.version_include` | `UPD2MQTT_VERSION_INCLUDE` |
-| `updates2mqtt.version_exclude` | `UPD2MQTT_VERSION_EXCLUDE` |
 
 
 ```yaml title="Example Compose Snippet"

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/pyproject.toml

@@ -7,9 +7,9 @@ authors = [
 ]
 
 requires-python = ">=3.13"
-version = "1.6.0"
+version = "1.7.0"
 license="Apache-2.0"
-keywords=["mqtt", "docker", "updates", "automation","home-assistant","homeassistant","selfhosting"]
+keywords=["mqtt", "docker", "oci","container","updates", "automation","home-assistant","homeassistant","selfhosting"]
 
 dependencies = [
   "docker>=7.1.0",
@@ -20,6 +20,7 @@ dependencies = [
   "httpx>=0.28.1",
   "hishel[httpx]>=0.1.4",
   "usingversion>=0.1.2",
+  "tzlocal>=5.3.1",
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -70,7 +71,8 @@ docs=[
     "pymdown-extensions",
     "mkdocs-git-revision-date-localized-plugin",
     "mkdocs-meta-descriptions-plugin",
-    "pngquant"
+    "pngquant",
+    "mkdocs-mermaid2-plugin"
 ]
 
 [build-system]
@@ -150,7 +152,6 @@ skip-magic-trailing-comma = false
 # Like Black, automatically detect the appropriate line ending.
 line-ending = "auto"
 
-
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 testpaths = [
@@ -187,4 +188,4 @@ Homepage="https://updates2mqtt.rhizomatics.org.uk"
 Repository="https://github.com/rhizomatics/updates2mqtt"
 Documentation="https://updates2mqtt.rhizomatics.org.uk"
 Issues="https://github.com/rhizomatics/updates2mqtt/issues"
-Changelog="https://github.com/rhizomatics/updates2mqtt/blob/main/CHANGELOG.md"
+Changelog="https://github.com/rhizomatics/updates2mqtt/blob/main/CHANGELOG.md"

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/src/updates2mqtt/app.py

@@ -14,7 +14,7 @@ import structlog
 import updates2mqtt
 from updates2mqtt.model import Discovery, ReleaseProvider
 
-from .config import Config, PackageUpdateInfo, load_app_config, load_package_info
+from .config import Config, PublishPolicy, UpdatePolicy, load_app_config
 from .integrations.docker import DockerProvider
 from .mqtt import MqttPublisher
 
@@ -49,7 +49,6 @@ class App:
 
         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: dict[str, PackageUpdateInfo] = load_package_info(PKG_INFO_FILE)
 
         self.publisher = MqttPublisher(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
 
@@ -57,7 +56,7 @@ class App:
         self.scan_count: int = 0
         self.last_scan: str | None = None
         if self.cfg.docker.enabled:
-            self.scanners.append(DockerProvider(self.cfg.docker, self.common_pkg, self.cfg.node, self.self_bounce))
+            self.scanners.append(DockerProvider(self.cfg.docker, self.cfg.node, self.self_bounce))
         self.stopped = Event()
         self.healthcheck_topic = self.cfg.node.healthcheck.topic_template.format(node_name=self.cfg.node.name)
 
@@ -104,6 +103,7 @@ class App:
             )
 
         for scanner in self.scanners:
+            scanner.initialize()
             self.publisher.subscribe_hass_command(scanner)
 
         while not self.stopped.is_set() and self.publisher.is_available():
@@ -122,12 +122,15 @@ class App:
     async def on_discovery(self, discovery: Discovery) -> None:
         dlog = log.bind(name=discovery.name)
         try:
-            if self.cfg.homeassistant.discovery.enabled:
+            if discovery.publish_policy == PublishPolicy.HOMEASSISTANT and self.cfg.homeassistant.discovery.enabled:
+                # Switch off MQTT discovery if not Home Assistant enabled
                 self.publisher.publish_hass_config(discovery)
-
-            self.publisher.publish_hass_state(discovery)
+            if discovery.publish_policy in (PublishPolicy.HOMEASSISTANT):
+                self.publisher.publish_hass_state(discovery)
+            if discovery.publish_policy in (PublishPolicy.HOMEASSISTANT, PublishPolicy.MQTT):
+                self.publisher.publish_discovery(discovery)
             if (
-                discovery.update_policy == "Auto"
+                discovery.update_policy == UpdatePolicy.AUTO
                 and discovery.can_update
                 and discovery.latest_version != discovery.current_version
             ):

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/src/updates2mqtt/config.py

@@ -9,6 +9,20 @@ from omegaconf import MISSING, DictConfig, MissingMandatoryValue, OmegaConf, Val
 
 log = structlog.get_logger()
 
+PKG_INFO_FILE = Path("./common_packages.yaml")
+NO_KNOWN_IMAGE = "UNKNOWN"
+
+
+class UpdatePolicy(StrEnum):
+    AUTO = "Auto"
+    PASSIVE = "Passive"
+
+
+class PublishPolicy(StrEnum):
+    HOMEASSISTANT = "HomeAssistant"
+    MQTT = "MQTT"
+    SILENT = "Silent"
+
 
 class LogLevel(StrEnum):
     DEBUG = "DEBUG"
@@ -18,6 +32,13 @@ class LogLevel(StrEnum):
     CRITICAL = "CRITICAL"
 
 
+class VersionType:
+    SHORT_SHA = "short_sha"
+    FULL_SHA = "full_sha"
+    VERSION_REVISION = "version_revision"
+    VERSION = "version"
+
+
 @dataclass
 class MqttConfig:
     host: str = "${oc.env:MQTT_HOST,localhost}"
@@ -34,6 +55,12 @@ class MetadataSourceConfig:
     cache_ttl: int = 60 * 60 * 24 * 7  # 1 week
 
 
+@dataclass
+class Selector:
+    include: list[str] | None = None
+    exclude: list[str] | None = None
+
+
 @dataclass
 class DockerConfig:
     enabled: bool = True
@@ -47,7 +74,8 @@ class DockerConfig:
     discover_metadata: dict[str, MetadataSourceConfig] = field(
         default_factory=lambda: {"linuxserver.io": MetadataSourceConfig(enabled=True)}
     )
-    api_throttle_wait: int = 60 * 15
+    default_api_backoff: int = 60 * 15
+    image_ref_select: Selector = field(default_factory=lambda: Selector())
 
 
 @dataclass
@@ -62,6 +90,7 @@ class HomeAssistantConfig:
     state_topic_suffix: str = "state"
     device_creation: bool = True
     force_command_topic: bool = False
+    extra_attributes: bool = True
     area: str | None = None
 
 
@@ -115,24 +144,6 @@ class IncompleteConfigException(BaseException):
     pass
 
 
-def load_package_info(pkginfo_file_path: Path) -> dict[str, PackageUpdateInfo]:
-    if pkginfo_file_path.exists():
-        log.debug("Loading common package update info", path=pkginfo_file_path)
-        cfg = OmegaConf.load(pkginfo_file_path)
-    else:
-        log.warn("No common package update info found", path=pkginfo_file_path)
-        cfg = OmegaConf.structured(UpdateInfoConfig)
-    try:
-        # omegaconf broken-ness on optional fields and converting to backclasses
-        pkg_conf: dict[str, PackageUpdateInfo] = {
-            pkg: PackageUpdateInfo(**pkg_cfg) for pkg, pkg_cfg in cfg.common_packages.items()
-        }
-        return pkg_conf
-    except (MissingMandatoryValue, ValidationError) as e:
-        log.error("Configuration error %s", e, path=pkginfo_file_path.as_posix())
-        raise
-
-
 def is_autogen_config() -> bool:
     env_var: str | None = os.environ.get("U2M_AUTOGEN_CONFIG")
     return not (env_var and env_var.lower() in ("no", "0", "false"))

{updates2mqtt-1.6.0 → updates2mqtt-1.7.0}/src/updates2mqtt/hass_formatter.py

@@ -23,28 +23,26 @@ def hass_format_config(
     object_id: str,
     state_topic: str,
     command_topic: str | None,
+    attrs_topic: str | None,
     force_command_topic: bool | None,
     device_creation: bool = True,
     area: str | None = None,
-    session: str | None = None,
 ) -> dict[str, Any]:
     config: dict[str, Any] = {
         "name": discovery.title,
         "device_class": None,  # not firmware, so defaults to null
         "unique_id": object_id,
         "state_topic": state_topic,
-        "source_session": session,
         "supported_features": discovery.features,
-        "can_update": discovery.can_update,
-        "can_build": discovery.can_build,
-        "can_restart": discovery.can_restart,
-        "update_policy": discovery.update_policy,
+        "default_entity_id": f"update.{discovery.node}_{discovery.provider.source_type}_{discovery.name}",
         "origin": {
             "name": f"{discovery.node} updates2mqtt",
             "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
     }
+    if attrs_topic:
+        config["json_attributes_topic"] = attrs_topic
     if discovery.entity_picture_url:
         config["entity_picture"] = discovery.entity_picture_url
     if discovery.device_icon:
@@ -62,14 +60,12 @@ def hass_format_config(
         config["command_topic"] = command_topic
         if discovery.can_update:
             config["payload_install"] = f"{discovery.source_type}|{discovery.name}|install"
-    config["custom"] = {}
-    config["custom"][discovery.source_type] = discovery.custom
-    config.update(discovery.provider.hass_config_format(discovery))
+
     return config
 
 
 def hass_format_state(discovery: Discovery, session: str, in_progress: bool = False) -> dict[str, Any]:  # noqa: ARG001
-    state = {
+    state: dict[str, str | dict | list | bool | None] = {
         "installed_version": discovery.current_version,
         "latest_version": discovery.latest_version,
         "title": discovery.title,
@@ -79,11 +75,5 @@ def hass_format_state(discovery: Discovery, session: str, in_progress: bool = Fa
         state["release_summary"] = discovery.release_summary
     if discovery.release_url:
         state["release_url"] = discovery.release_url
-    custom_state = discovery.provider.hass_state_format(discovery)
-    if custom_state:
-        state.update(custom_state)
-    invalid_keys = [k for k in state if k not in HASS_UPDATE_SCHEMA]
-    if invalid_keys:
-        log.warning(f"Invalid keys in state: {invalid_keys}")
-        state = {k: v for k, v in state.items() if k in HASS_UPDATE_SCHEMA}
+
     return state