switch-api 0.6.16__tar.gz → 0.6.18__tar.gz

switch_api-0.6.16/PKG-INFO → switch_api-0.6.18/HISTORY.md

@@ -1,43 +1,25 @@
-Metadata-Version: 2.1
-Name: switch_api
-Version: 0.6.16
-Summary: A complete package for data ingestion into the Switch Automation Platform.
-Home-page: UNKNOWN
-Author: Switch Automation Pty Ltd.
-License: MIT License
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Intended Audience :: Other Audience
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Natural Language :: English
-Requires-Python: >=3.8.0
-Description-Content-Type: text/markdown
-License-File: LICENCE
-License-File: AUTHORS.rst
-
-# Switch Automation library for Python
-This is a package for data ingestion into the Switch Automation software platform. 
-
-You can find out more about the platform on [Switch Automation](https://www.switchautomation.com)
-
-## Getting started
-
-### Prerequisites
-* Python 3.8 or later is required to use this package. 
-* You must have a [Switch Automation user account](https://www.switchautomation.com/our-solution/) to use this package. 
-
-### Install the package
-Install the Switch Automation library for Python with [pip](https://pypi.org/project/pip/):
-
-```bash
-pip install switch_api
-```
-
 # History
 
+#0.6.18
+### Changed
+In the `realtime` module:
+- Updated `submit_realtime_updates()` to use the passed `timeout` value when waiting for a retained MQTT message.
+- Added Redis-backed optimistic concurrency support for realtime dataset updates using WATCH/MULTI/EXEC.
+- Added `set_realtime_redis_config()` to configure Redis as the authoritative state store before publishing updates to MQTT.
+- Added `redis` package dependency for Redis-backed realtime state updates.
+- Added a maximum of 3 retained-message subscription attempts for connection or subscribe failures in the MQTT fallback path.
+- Preserved new-topic behavior: when no retained message exists and Redis is not configured, the provided dataframe is used and published as the initial retained dataset.
+- Updated `subscribe_with_retained_sync()` to apply the passed timeout to the MQTT connection, check subscribe failures, and log when no retained topics are received within the wait period.
+- Added Redis timeout retry handling with a default maximum of 3 attempts for Redis realtime update operations.
+
+
+#0.6.17
+### Changed
+In the `integration` module:
+- Updated `upsert_sites()` to support `YearBuilt` and `Floors` as optional columns when upserting sites.
+- Documented `YearBuilt` and `Floors` in the `upsert_sites()` accepted fields list.
+- `get_sites()` now also returns `YearBuilt` and `Floors` columns.
+
 #0.6.16
 ### Changed
 In the `controls` module:
@@ -1189,5 +1171,3 @@ Removed the `name_as_filename` and `treat_as_timeseries` parameter from the foll
 - `switch.integration.replace_data()`
 - `switch.integration.append_data()`
 - `switch.integration.upload_data()`
-
-

{switch_api-0.6.16/switch_api.egg-info → switch_api-0.6.18}/PKG-INFO

@@ -1,11 +1,9 @@
-Metadata-Version: 2.1
-Name: switch-api
-Version: 0.6.16
+Metadata-Version: 2.4
+Name: switch_api
+Version: 0.6.18
 Summary: A complete package for data ingestion into the Switch Automation Platform.
-Home-page: UNKNOWN
 Author: Switch Automation Pty Ltd.
 License: MIT License
-Platform: UNKNOWN
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Other Audience
@@ -17,6 +15,28 @@ Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENCE
 License-File: AUTHORS.rst
+Requires-Dist: pandas==1.5.3
+Requires-Dist: requests
+Requires-Dist: azure-storage-blob
+Requires-Dist: pandera[io]==0.7.1
+Requires-Dist: azure-servicebus
+Requires-Dist: msal>=1.11.0
+Requires-Dist: paho-mqtt==1.6.1
+Requires-Dist: uvicorn==0.22.0
+Requires-Dist: fastapi==0.98.0
+Requires-Dist: pyodbc==4.0.39
+Requires-Dist: cachetools==5.5.0
+Requires-Dist: numexpr==2.10.2
+Requires-Dist: redis<6,>=4.5.5
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Switch Automation library for Python
 This is a package for data ingestion into the Switch Automation software platform. 
@@ -38,6 +58,26 @@ pip install switch_api
 
 # History
 
+#0.6.18
+### Changed
+In the `realtime` module:
+- Updated `submit_realtime_updates()` to use the passed `timeout` value when waiting for a retained MQTT message.
+- Added Redis-backed optimistic concurrency support for realtime dataset updates using WATCH/MULTI/EXEC.
+- Added `set_realtime_redis_config()` to configure Redis as the authoritative state store before publishing updates to MQTT.
+- Added `redis` package dependency for Redis-backed realtime state updates.
+- Added a maximum of 3 retained-message subscription attempts for connection or subscribe failures in the MQTT fallback path.
+- Preserved new-topic behavior: when no retained message exists and Redis is not configured, the provided dataframe is used and published as the initial retained dataset.
+- Updated `subscribe_with_retained_sync()` to apply the passed timeout to the MQTT connection, check subscribe failures, and log when no retained topics are received within the wait period.
+- Added Redis timeout retry handling with a default maximum of 3 attempts for Redis realtime update operations.
+
+
+#0.6.17
+### Changed
+In the `integration` module:
+- Updated `upsert_sites()` to support `YearBuilt` and `Floors` as optional columns when upserting sites.
+- Documented `YearBuilt` and `Floors` in the `upsert_sites()` accepted fields list.
+- `get_sites()` now also returns `YearBuilt` and `Floors` columns.
+
 #0.6.16
 ### Changed
 In the `controls` module:
@@ -1189,5 +1229,3 @@ Removed the `name_as_filename` and `treat_as_timeseries` parameter from the foll
 - `switch.integration.replace_data()`
 - `switch.integration.append_data()`
 - `switch.integration.upload_data()`
-
-

switch_api-0.6.18/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=64",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

{switch_api-0.6.16 → switch_api-0.6.18}/setup.py

@@ -16,11 +16,11 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.16",
+    version="0.6.18",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 
-                      'numexpr==2.10.2'],
+                      'numexpr==2.10.2', 'redis>=4.5.5,<6'],
     python_requires=">=3.8.0",
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',

{switch_api-0.6.16 → switch_api-0.6.18}/switch_api/__init__.py

@@ -10,7 +10,8 @@ Data Ingestion into the Switch Automation
 Complete package for ingestion data into the Switch Automation Platform.
 """
 __all__ = ['dataset', 'analytics', 'pipeline', 'error_handlers', 'integration',
-           'initialize', 'cache', 'extensions', 'email', 'controls', 'realtime', '_compute', 'generate_filepath', 'set_mqtt_broker_config']
+           'initialize', 'cache', 'extensions', 'email', 'controls', 'realtime', '_compute', 'generate_filepath',
+           'set_mqtt_broker_config', 'set_realtime_redis_config']
 
 from .initialize import initialize
 from . import dataset
@@ -27,6 +28,7 @@ from . import realtime
 from . import _compute
 from ._utils._utils import generate_filepath
 from ._utils._mqtt import set_mqtt_broker_config
+from .realtime import set_realtime_redis_config
 from . import _guide
 
 
@@ -42,4 +44,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.16"
+__version__ = "0.6.18"

{switch_api-0.6.16 → switch_api-0.6.18}/switch_api/integration/integration.py

@@ -840,6 +840,8 @@ def upsert_sites(df: pandas.DataFrame, api_inputs: ApiInputs, tag_columns: list
         - Latitude
         - Longitude
         - Timezone
+        - YearBuilt
+        - Floors
         - InstallationId
             - The UUID of the existing site within the Switch Automation Platform.
 
@@ -871,7 +873,7 @@ def upsert_sites(df: pandas.DataFrame, api_inputs: ApiInputs, tag_columns: list
 
     required_columns = ['InstallationName', 'InstallationCode', 'Address', 'Country', 'Suburb', 'State', 'StateName',
                         'FloorAreaM2', 'ZipPostCode']
-    optional_columns = ['Latitude', 'Longitude', 'Timezone', 'InstallationId']
+    optional_columns = ['Latitude', 'Longitude', 'Timezone', 'InstallationId', 'YearBuilt', 'Floors']
     proposed_columns = data_frame.columns.tolist()
 
     if not set(required_columns).issubset(proposed_columns):

{switch_api-0.6.16 → switch_api-0.6.18}/switch_api/realtime/__init__.py

@@ -8,5 +8,6 @@ A module for sending control request of sensors.
 """
 
 from .realtime import submit_realtime_updates
+from ._redis import set_realtime_redis_config
 
-__all__ = ['submit_realtime_updates']
+__all__ = ['submit_realtime_updates', 'set_realtime_redis_config']

{switch_api-0.6.16 → switch_api-0.6.18}/switch_api/realtime/_mqtt.py

@@ -7,7 +7,6 @@
 A module containing the SwithRealtime class and associated methods referenced by the controls module in the package. This
 module is not directly referenced by end users.
 """
-import json
 import logging
 import sys
 import threading
@@ -109,8 +108,6 @@ class SwitchRealtime:
         if topics is None:
             raise ValueError("topics cannot be None")
 
-        self.connect()
-
         topics = list(topics)
 
         if not topics:
@@ -122,6 +119,11 @@ class SwitchRealtime:
         if not isinstance(timeout, int) or timeout <= 0:
             raise ValueError("timeout must be a positive integer")
 
+        if not self.connect(timeout=timeout):
+            raise TimeoutError(
+                f"Could not connect to MQTT Broker within {timeout} seconds."
+            )
+
         # --- Initialize tracking ---
         self._expected_topics = set(topics)
         self._received_retained = set()
@@ -129,19 +131,32 @@ class SwitchRealtime:
 
         # --- Subscribe ---
         for topic in topics:
-            self.client.subscribe(topic)
+            result, _ = self.client.subscribe(topic)
+            if result != mqtt.MQTT_ERR_SUCCESS:
+                raise RuntimeError(
+                    f"Failed to subscribe to {topic}. MQTT result code: {result}"
+                )
             logger.info(f"Subscribed to = {topic}")
 
         # --- Wait until all retained received OR timeout ---
-        self._retained_event.wait(timeout=timeout)
+        received_all = self._retained_event.wait(timeout=timeout)
 
         # --- Return only retained dataset ---
-        return {
+        retained_dataset = {
             topic: self.topic_state[topic]["payload"]
             for topic in self._received_retained
             if topic in self.topic_state
         }
 
+        if not received_all:
+            missing_topics = self._expected_topics - self._received_retained
+            logger.info(
+                f"No retained messages received within {timeout} seconds "
+                f"for topics: {sorted(missing_topics)}"
+            )
+
+        return retained_dataset
+
 
     def publish(self, topic: str, payload: str, qos: int = 1, retain: bool = True):
         """
@@ -151,7 +166,11 @@ class SwitchRealtime:
         result = self.client.publish(topic, payload, qos=qos, retain=retain)
 
         if result.rc != mqtt.MQTT_ERR_SUCCESS:
-            logger.error(f"Failed to publish to {topic} : {json.loads(payload)}")
+            message = f"Failed to publish to {topic}. MQTT result code: {result.rc}"
+            logger.error(message)
+            raise RuntimeError(message)
+
+        return result
 
 
 
@@ -202,4 +221,4 @@ class SwitchRealtime:
                 self._retained_event.set()
 
         else:
-           logger.info(f'MQTT Message - {topic} : {payload}')
+           logger.info(f'MQTT Message - {topic} : {payload}')