updates2mqtt 1.5.0__py3-none-any.whl → 1.5.1__py3-none-any.whl

updates2mqtt/config.py

@@ -25,7 +25,7 @@ class MqttConfig:
     password: str = f"${{oc.env:MQTT_PASS,{MISSING}}}"
     port: int = "${oc.decode:${oc.env:MQTT_PORT,1883}}"  # type: ignore[assignment]
     topic_root: str = "updates2mqtt"
-    protocol: str = "3.11"
+    protocol: str = "${oc.env:MQTT_VERSION,3.11}"
 
 
 @dataclass
@@ -80,12 +80,12 @@ class NodeConfig:
 
 @dataclass
 class LogConfig:
-    level: LogLevel = LogLevel.INFO
+    level: LogLevel = "${oc.decode:${oc.env:U2M_LOG_LEVEL,INFO}}"  # type: ignore[assignment] # pyright: ignore[reportAssignmentType]
 
 
 @dataclass
 class Config:
-    log: LogConfig = field(default_factory=LogConfig)
+    log: LogConfig = field(default_factory=LogConfig)  # pyright: ignore[reportArgumentType, reportCallIssue]
     node: NodeConfig = field(default_factory=NodeConfig)
     mqtt: MqttConfig = field(default_factory=MqttConfig)  # pyright: ignore[reportArgumentType, reportCallIssue]
     homeassistant: HomeAssistantConfig = field(default_factory=HomeAssistantConfig)
@@ -132,22 +132,29 @@ def load_package_info(pkginfo_file_path: Path) -> dict[str, PackageUpdateInfo]:
         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"))
+
+
 def load_app_config(conf_file_path: Path, return_invalid: bool = False) -> Config | None:
     base_cfg: DictConfig = OmegaConf.structured(Config)
     if conf_file_path.exists():
         cfg: DictConfig = typing.cast("DictConfig", OmegaConf.merge(base_cfg, OmegaConf.load(conf_file_path)))
-    else:
+    elif is_autogen_config():
         if not conf_file_path.parent.exists():
             try:
                 log.debug(f"Creating config directory {conf_file_path.parent} if not already present")
                 conf_file_path.parent.mkdir(parents=True, exist_ok=True)
             except Exception:
-                log.exception("Unable to create config directory", path=conf_file_path.parent)
+                log.warning("Unable to create config directory", path=conf_file_path.parent)
         try:
             conf_file_path.write_text(OmegaConf.to_yaml(base_cfg))
             log.info(f"Auto-generated a new config file at {conf_file_path}")
         except Exception:
-            log.exception("Unable to write config file", path=conf_file_path)
+            log.warning("Unable to write config file", path=conf_file_path)
+        cfg = base_cfg
+    else:
         cfg = base_cfg
 
     try:

updates2mqtt/hass_formatter.py

@@ -21,7 +21,6 @@ HASS_UPDATE_SCHEMA = [
 def hass_format_config(
     discovery: Discovery,
     object_id: str,
-    node_name: str,
     state_topic: str,
     command_topic: str | None,
     force_command_topic: bool | None,
@@ -29,13 +28,8 @@ def hass_format_config(
     area: str | None = None,
     session: str | None = None,
 ) -> dict[str, Any]:
-    if device_creation:
-        # avoid duplication, since Home Assistant will concatenate device and entity name on update
-        name: str = f"{discovery.name} {discovery.source_type}"
-    else:
-        name = f"{discovery.name} {discovery.source_type} on {node_name}"
     config: dict[str, Any] = {
-        "name": name,
+        "name": discovery.title,
         "device_class": None,  # not firmware, so defaults to null
         "unique_id": object_id,
         "state_topic": state_topic,
@@ -46,7 +40,7 @@ def hass_format_config(
         "can_restart": discovery.can_restart,
         "update_policy": discovery.update_policy,
         "origin": {
-            "name": f"{node_name} updates2mqtt",
+            "name": f"{discovery.node} updates2mqtt",
             "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
@@ -57,10 +51,10 @@ def hass_format_config(
         config["icon"] = discovery.device_icon
     if device_creation:
         config["device"] = {
-            "name": f"{node_name} updates2mqtt",
+            "name": f"{discovery.node} updates2mqtt",
             "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "manufacturer": "rhizomatics",
-            "identifiers": [f"{node_name}.updates2mqtt"],
+            "identifiers": [f"{discovery.node}.updates2mqtt"],
         }
         if area:
             config["device"]["suggested_area"] = area
@@ -74,14 +68,11 @@ def hass_format_config(
     return config
 
 
-def hass_format_state(discovery: Discovery, node_name: str, session: str, in_progress: bool = False) -> dict[str, Any]:  # noqa: ARG001
-    title: str = (
-        discovery.title_template.format(name=discovery.name, node=node_name) if discovery.title_template else discovery.name
-    )
+def hass_format_state(discovery: Discovery, session: str, in_progress: bool = False) -> dict[str, Any]:  # noqa: ARG001
     state = {
         "installed_version": discovery.current_version,
         "latest_version": discovery.latest_version,
-        "title": title,
+        "title": discovery.title,
         "in_progress": in_progress,
     }
     if discovery.release_summary:

updates2mqtt/integrations/docker.py

@@ -101,18 +101,22 @@ class DockerProvider(ReleaseProvider):
         if not cwd or not Path(cwd).is_dir():
             logger.warn("Invalid compose path, skipped %s", command)
             return False
-        logger.info(f"Executing compose {command} {args} {service}")
+
         cmd: str = "docker-compose" if self.cfg.compose_version == "v1" else "docker compose"
+        logger.info(f"Executing {cmd} {command} {args} {service}")
         cmd = cmd + " " + command.value
         if args:
             cmd = cmd + " " + args
         if service:
             cmd = cmd + " " + service
 
-        proc = subprocess.run(cmd, check=False, shell=True, cwd=cwd)
+        proc: subprocess.CompletedProcess[str] = subprocess.run(cmd, check=False, shell=True, cwd=cwd, text=True)
         if proc.returncode == 0:
             logger.info(f"{command} via compose successful")
             return True
+        if proc.stderr and "unknown command: docker compose" in proc.stderr:
+            logger.warning("docker compose set to wrong version, seems like v1 installed")
+            self.cfg.compose_version = "v1"
         logger.warn(
             f"{command} failed: %s",
             proc.returncode,
@@ -275,6 +279,12 @@ class DockerProvider(ReleaseProvider):
                 logger.info(f"Update not available, can_pull:{can_pull}, can_build:{can_build},can_restart{can_restart}")
             if relnotes_url:
                 features.append("RELEASE_NOTES")
+            if can_pull:
+                update_type: str = "Docker Image"
+            elif can_build:
+                update_type = "Docker Build"
+            else:
+                update_type = "Unavailable"
             custom["can_pull"] = can_pull
 
             logger.debug("Analyze generated discovery", discovery_name=c.name, current_version=local_version)
@@ -282,15 +292,16 @@ class DockerProvider(ReleaseProvider):
                 self,
                 c.name,
                 session,
+                node=self.node_cfg.name,
                 entity_picture_url=picture_url,
                 release_url=relnotes_url,
                 current_version=local_version,
                 update_policy=update_policy,
                 update_last_attempt=(original_discovery and original_discovery.update_last_attempt) or None,
                 latest_version=latest_version if latest_version != NO_KNOWN_IMAGE else local_version,
-                title_template="Docker image update for {name} on {node}",
                 device_icon=self.cfg.device_icon,
                 can_update=can_update,
+                update_type=update_type,
                 can_build=can_build,
                 can_restart=can_restart,
                 status=(c.status == "running" and "on") or "off",

updates2mqtt/model.py

@@ -14,6 +14,7 @@ class Discovery:
         provider: "ReleaseProvider",
         name: str,
         session: str,
+        node: str,
         entity_picture_url: str | None = None,
         current_version: str | None = None,
         latest_version: str | None = None,
@@ -21,11 +22,12 @@ class Discovery:
         can_build: bool = False,
         can_restart: bool = False,
         status: str = "on",
+        update_type: str | None = "Update",
         update_policy: str | None = None,
         update_last_attempt: float | None = None,
         release_url: str | None = None,
         release_summary: str | None = None,
-        title_template: str = "Update for {name} on {node}",
+        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,
@@ -34,6 +36,7 @@ class Discovery:
         self.source_type: str = provider.source_type
         self.session: str = session
         self.name: str = name
+        self.node: str = node
         self.entity_picture_url: str | None = entity_picture_url
         self.current_version: str | None = current_version
         self.latest_version: str | None = latest_version
@@ -44,6 +47,7 @@ class Discovery:
         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
         self.status: str = status
         self.update_policy: str | None = update_policy
         self.update_last_attempt: float | None = update_last_attempt
@@ -54,6 +58,12 @@ class Discovery:
         """Build a custom string representation"""
         return f"Discovery('{self.name}','{self.source_type}',current={self.current_version},latest={self.latest_version})"
 
+    @property
+    def title(self) -> str:
+        if self.title_template:
+            return self.title_template.format(discovery=self)
+        return self.name
+
 
 class ReleaseProvider:
     """Abstract base class for release providers, such as container scanners or package managers API calls"""

updates2mqtt/mqtt.py

@@ -309,7 +309,6 @@ class MqttPublisher:
             self.state_topic(discovery),
             hass_format_state(
                 discovery,
-                self.node_cfg.name,
                 discovery.session,
                 in_progress=in_progress,
             ),
@@ -322,7 +321,6 @@ class MqttPublisher:
             hass_format_config(
                 discovery=discovery,
                 object_id=object_id,
-                node_name=self.node_cfg.name,
                 area=self.hass_cfg.area,
                 state_topic=self.state_topic(discovery),
                 command_topic=self.command_topic(discovery.provider),

{updates2mqtt-1.5.0.dist-info → updates2mqtt-1.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.5.0
+Version: 1.5.1
 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

updates2mqtt-1.5.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
+updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
+updates2mqtt/app.py,sha256=pYcNprv7_htqD6wiXX5j24FhPglEeFNdqMfPclq5SfU,8887
+updates2mqtt/config.py,sha256=nlAszykZa7t9nu99RB8g_tIzQxmdfWyilTZJY3Fl4e4,6099
+updates2mqtt/hass_formatter.py,sha256=bj6qpElMqt1DqKlxp4ZjwaCJAD-ed3xsq5ZOg4FbeC8,3216
+updates2mqtt/model.py,sha256=KNsLflgWaRvGrNdq1Vy2QnDLfVSLPWLSt4gBXj9COa4,4170
+updates2mqtt/mqtt.py,sha256=j7nlSka-LqRethZk_rc4Z8iOV7ey28TQFjSfrPeTjv4,14995
+updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
+updates2mqtt/integrations/docker.py,sha256=Mi3tFjVDbCIsHBgH6UQ3yC5Y7HQk9JgEyH6PQuNJtFU,21263
+updates2mqtt/integrations/git_utils.py,sha256=bPCmQiZpKpMcrGI7xAVmePXHFn8WwjcPNkf7xqDsGQA,2319
+updates2mqtt-1.5.1.dist-info/METADATA,sha256=iPMKAgEFTFZ98pouv3SnTTStP74SEPBuV8jN3QbBpX8,9392
+updates2mqtt-1.5.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+updates2mqtt-1.5.1.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
+updates2mqtt-1.5.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+updates2mqtt-1.5.1.dist-info/RECORD,,

updates2mqtt-1.5.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=pYcNprv7_htqD6wiXX5j24FhPglEeFNdqMfPclq5SfU,8887
-updates2mqtt/config.py,sha256=TJakojUkPJ0xJ2aivJ9BIlDLw8glqJzTOsm1E__vJ9M,5706
-updates2mqtt/hass_formatter.py,sha256=adopRRagQte7ok1ZBPcYBIkDAo9YLXcI2y_jtdNWZP8,3638
-updates2mqtt/model.py,sha256=O6GQFhfQvwQDxlZScFHrpQgFNkUrUAeaGGP6AqNua78,3827
-updates2mqtt/mqtt.py,sha256=yNpYlYdDr6S4ltLZqAbjUgxsJQZKzOfcFJoUr-fcNlI,15077
-updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
-updates2mqtt/integrations/docker.py,sha256=dTbiIB2bjiGY46ovlkiB998ekhXX4M2KhvZqfzqV-Oo,20790
-updates2mqtt/integrations/git_utils.py,sha256=bPCmQiZpKpMcrGI7xAVmePXHFn8WwjcPNkf7xqDsGQA,2319
-updates2mqtt-1.5.0.dist-info/METADATA,sha256=oowFbgm4wTYWv3vlBTgiYe3prCI2UVTJztMT4GWLEN8,9392
-updates2mqtt-1.5.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-updates2mqtt-1.5.0.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
-updates2mqtt-1.5.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-updates2mqtt-1.5.0.dist-info/RECORD,,