Poetry: Enable dynamic versioning based on git tags

Author: nanomad

pyproject.toml

@@ -1,6 +1,5 @@
 [project]
 name = "saic-python-mqtt-gateway"
-version = "0.9.4"
 description = "A service that queries the data from an MG iSMART account and publishes the data over MQTT and to other sources"
 authors = [
     { name = "Giovanni Condello", email = "saic-python-client@nanomad.net" }
@@ -22,14 +21,20 @@ dependencies = [
     'inflection (>=0.5.1,<0.6.0)',
     'apscheduler (>=3.11.0,<4.0.0)',
 ]
+dynamic = ["version"]
 
 [project.urls]
 Homepage = "https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway"
 Issues = "https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway/issues"
 
+[build-system]
+requires = ["poetry-core>=2.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
+
 [tool.poetry]
 package-mode = false
 requires-poetry = '>=2.0,<3.0'
+version = "0.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"
@@ -45,9 +50,14 @@ pylint = "^3.3.6"
 [tool.poetry.dependencies]
 saic-ismart-client-ng = { develop = true }
 
-[build-system]
-requires = ["poetry-core>=2.0.0"]
-build-backend = "poetry.core.masonry.api"
+[tool.poetry.requires-plugins]
+poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
+
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+style = "semver"
+pattern = "default-unprefixed"
 
 [tool.pytest.ini_options]
 norecursedirs = ".git build dist"
@@ -250,4 +260,4 @@ score = false
 expected-line-ending-format = "LF"
 
 [tool.pylint.EXCEPTIONS]
-overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
+overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]

src/configuration/__init__.py

@@ -3,6 +3,8 @@
 from enum import Enum
 from typing import TYPE_CHECKING
 
+from saic_ismart_client_ng.model import DEFAULT_BASE_URI, DEFAULT_REGION, DEFAULT_TENANT_ID, DEFAULT_USER_AGENT
+
 if TYPE_CHECKING:
     from integrations.openwb.charging_station import ChargingStation
 
@@ -22,9 +24,10 @@ def __init__(self) -> None:
         self.saic_user: str | None = None
         self.saic_password: str | None = None
         self.__saic_phone_country_code: str | None = None
-        self.saic_rest_uri: str = "https://gateway-mg-eu.soimt.com/api.app/v1/"
-        self.saic_region: str = "eu"
-        self.saic_tenant_id: str = "459771"
+        self.saic_rest_uri: str = DEFAULT_BASE_URI
+        self.saic_region: str = DEFAULT_REGION
+        self.saic_tenant_id: str = DEFAULT_TENANT_ID
+        self.saic_user_agent: str = DEFAULT_USER_AGENT
         self.saic_relogin_delay: int = 15 * 60  # in seconds
         self.saic_read_timeout: float = 10.0  # in seconds
         self.battery_capacity_map: dict[str, float] = {}

src/configuration/parser.py

@@ -6,6 +6,8 @@
 from pathlib import Path
 import urllib.parse
 
+from saic_ismart_client_ng.model import DEFAULT_TENANT_ID, DEFAULT_REGION, DEFAULT_USER_AGENT, DEFAULT_BASE_URI
+
 from configuration import Configuration, TransportProtocol
 from configuration.argparse_extensions import (
     EnvDefault,
@@ -60,9 +62,9 @@ def process_arguments() -> Configuration:
             "-m",
             "--mqtt-uri",
             help="The URI to the MQTT Server. Environment Variable: MQTT_URI,"
-            "TCP: tcp://mqtt.eclipseprojects.io:1883 "
-            "WebSocket: ws://mqtt.eclipseprojects.io:9001"
-            "TLS: tls://mqtt.eclipseprojects.io:8883",
+                 "TCP: tcp://mqtt.eclipseprojects.io:1883 "
+                 "WebSocket: ws://mqtt.eclipseprojects.io:9001"
+                 "TLS: tls://mqtt.eclipseprojects.io:8883",
             dest="mqtt_uri",
             required=False,
             action=EnvDefault,
@@ -95,8 +97,8 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--mqtt-client-id",
             help="The MQTT Client Identifier. Environment Variable: "
-            "MQTT_CLIENT_ID "
-            "Default is saic-python-mqtt-gateway",
+                 "MQTT_CLIENT_ID "
+                 "Default is saic-python-mqtt-gateway",
             default="saic-python-mqtt-gateway",
             dest="mqtt_client_id",
             required=False,
@@ -126,8 +128,8 @@ def process_arguments() -> Configuration:
             "-s",
             "--saic-rest-uri",
             help="The SAIC uri. Environment Variable: SAIC_REST_URI Default is the European "
-            "Production Endpoint: https://tap-eu.soimt.com",
-            default="https://gateway-mg-eu.soimt.com/api.app/v1/",
+                 f"Production Endpoint: {DEFAULT_BASE_URI}",
+            default=DEFAULT_BASE_URI,
             dest="saic_rest_uri",
             required=False,
             action=EnvDefault,
@@ -162,28 +164,37 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--saic-region",
             "--saic-region",
-            help="The SAIC API region. Environment Variable: SAIC_REGION",
-            default="eu",
+            help=f"The SAIC API region. Default is {DEFAULT_REGION}. Environment Variable: SAIC_REGION",
+            default=DEFAULT_REGION,
             dest="saic_region",
             required=False,
             action=EnvDefault,
             envvar="SAIC_REGION",
         )
         parser.add_argument(
             "--saic-tenant-id",
-            help="The SAIC API tenant id. Environment Variable: SAIC_TENANT_ID",
-            default="459771",
+            help=f"The SAIC API tenant id. Default is {DEFAULT_TENANT_ID}. Environment Variable: SAIC_TENANT_ID",
+            default=DEFAULT_TENANT_ID,
             dest="saic_tenant_id",
             required=False,
             action=EnvDefault,
             envvar="SAIC_TENANT_ID",
         )
+        parser.add_argument(
+            "--saic-user-agent",
+            help="The SAIC API User Agent. Defaults to the latest iOS app. Environment Variable: SAIC_USER_AGENT",
+            default=DEFAULT_USER_AGENT,
+            dest="saic_user_agent",
+            required=False,
+            action=EnvDefault,
+            envvar="SAIC_USER_AGENT",
+        )
         parser.add_argument(
             "--battery-capacity-mapping",
             help="The mapping of VIN to full batteryc"
-            " apacity. Multiple mappings can be provided separated"
-            " by , Example: LSJXXXX=54.0,LSJYYYY=64.0,"
-            " Environment Variable: BATTERY_CAPACITY_MAPPING",
+                 " apacity. Multiple mappings can be provided separated"
+                 " by , Example: LSJXXXX=54.0,LSJYYYY=64.0,"
+                 " Environment Variable: BATTERY_CAPACITY_MAPPING",
             dest="battery_capacity_mapping",
             required=False,
             action=EnvDefault,
@@ -200,7 +211,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--saic-relogin-delay",
             help="How long to wait before attempting another login to the SAIC API. Environment "
-            "Variable: SAIC_RELOGIN_DELAY",
+                 "Variable: SAIC_RELOGIN_DELAY",
             dest="saic_relogin_delay",
             required=False,
             action=EnvDefault,
@@ -210,7 +221,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--saic-read-timeout",
             help="HTTP Read timeout for the SAIC API. Environment "
-            "Variable: SAIC_READ_TIMEOUT",
+                 "Variable: SAIC_READ_TIMEOUT",
             dest="saic_read_timeout",
             required=False,
             action=EnvDefault,
@@ -239,7 +250,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--ha-show-unavailable",
             help="Show entities as Unavailable in Home Assistant when car polling fails. "
-            "Environment Variable: HA_SHOW_UNAVAILABLE",
+                 "Environment Variable: HA_SHOW_UNAVAILABLE",
             dest="ha_show_unavailable",
             required=False,
             action=EnvDefault,
@@ -250,7 +261,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--messages-request-interval",
             help="The interval for retrieving messages in seconds. Environment Variable: "
-            "MESSAGES_REQUEST_INTERVAL",
+                 "MESSAGES_REQUEST_INTERVAL",
             dest="messages_request_interval",
             required=False,
             action=EnvDefault,
@@ -260,7 +271,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--charge-min-percentage",
             help="How many % points we should try to refresh the charge state. Environment Variable: "
-            "CHARGE_MIN_PERCENTAGE",
+                 "CHARGE_MIN_PERCENTAGE",
             dest="charge_dynamic_polling_min_percentage",
             required=False,
             action=EnvDefault,
@@ -271,7 +282,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--publish-raw-api-data",
             help="Publish raw SAIC API request/response to MQTT. Environment Variable: "
-            "PUBLISH_RAW_API_DATA_ENABLED",
+                 "PUBLISH_RAW_API_DATA_ENABLED",
             dest="publish_raw_api_data",
             required=False,
             action=EnvDefault,
@@ -284,9 +295,9 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--abrp-api-key",
             help="The API key for the A Better Route Planer telemetry API."
-            " Default is the open source telemetry"
-            " API key 8cfc314b-03cd-4efe-ab7d-4431cd8f2e2d."
-            " Environment Variable: ABRP_API_KEY",
+                 " Default is the open source telemetry"
+                 " API key 8cfc314b-03cd-4efe-ab7d-4431cd8f2e2d."
+                 " Environment Variable: ABRP_API_KEY",
             default="8cfc314b-03cd-4efe-ab7d-4431cd8f2e2d",
             dest="abrp_api_key",
             required=False,
@@ -296,9 +307,9 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--abrp-user-token",
             help="The mapping of VIN to ABRP User Token."
-            " Multiple mappings can be provided seperated by ,"
-            " Example: LSJXXXX=12345-abcdef,LSJYYYY=67890-ghijkl,"
-            " Environment Variable: ABRP_USER_TOKEN",
+                 " Multiple mappings can be provided seperated by ,"
+                 " Example: LSJXXXX=12345-abcdef,LSJYYYY=67890-ghijkl,"
+                 " Environment Variable: ABRP_USER_TOKEN",
             dest="abrp_user_token",
             required=False,
             action=EnvDefault,
@@ -307,7 +318,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--publish-raw-abrp-data",
             help="Publish raw ABRP API request/response to MQTT. Environment Variable: "
-            "PUBLISH_RAW_ABRP_DATA_ENABLED",
+                 "PUBLISH_RAW_ABRP_DATA_ENABLED",
             dest="publish_raw_abrp_data",
             required=False,
             action=EnvDefault,
@@ -319,8 +330,8 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--osmand-server-uri",
             help="The URL of your OsmAnd Server."
-            " Default unset"
-            " Environment Variable: OSMAND_SERVER_URI",
+                 " Default unset"
+                 " Environment Variable: OSMAND_SERVER_URI",
             default=None,
             dest="osmand_server_uri",
             required=False,
@@ -330,10 +341,10 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--osmand-device-id",
             help="The mapping of VIN to OsmAnd Device ID."
-            " Multiple mappings can be provided seperated by ,"
-            " Example: LSJXXXX=12345-abcdef,LSJYYYY=67890-ghijkl,"
-            " Default is to use the car VIN as Device ID, "
-            " Environment Variable: OSMAND_DEVICE_ID",
+                 " Multiple mappings can be provided seperated by ,"
+                 " Example: LSJXXXX=12345-abcdef,LSJYYYY=67890-ghijkl,"
+                 " Default is to use the car VIN as Device ID, "
+                 " Environment Variable: OSMAND_DEVICE_ID",
             dest="osmand_device_id",
             required=False,
             action=EnvDefault,
@@ -342,7 +353,7 @@ def process_arguments() -> Configuration:
         parser.add_argument(
             "--publish-raw-osmand-data",
             help="Publish raw ABRP OsmAnd request/response to MQTT. Environment Variable: "
-            "PUBLISH_RAW_OSMAND_DATA_ENABLED",
+                 "PUBLISH_RAW_OSMAND_DATA_ENABLED",
             dest="publish_raw_osmand_data",
             required=False,
             action=EnvDefault,
@@ -370,6 +381,7 @@ def process_arguments() -> Configuration:
         config.saic_rest_uri = args.saic_rest_uri
         config.saic_region = args.saic_region
         config.saic_tenant_id = str(args.saic_tenant_id)
+        config.saic_user_agent = args.saic_user_agent
         config.saic_user = args.saic_user
         config.saic_password = args.saic_password
         config.saic_phone_country_code = args.saic_phone_country_code