layrz-sdk 3.0.6__tar.gz → 3.0.8__tar.gz

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: layrz-sdk
-Version: 3.0.6
+Version: 3.0.8
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>
@@ -26,6 +26,11 @@ Managed by Golden M, Inc.
 It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
 incorporate them into your own projects.
 
+## Requirements
+This library uses at least Python 3.10 or higher to work.
+
+If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
+
 ## Documentation
 It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
 

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/README.md

@@ -6,6 +6,11 @@ Managed by Golden M, Inc.
 It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
 incorporate them into your own projects.
 
+## Requirements
+This library uses at least Python 3.10 or higher to work.
+
+If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
+
 ## Documentation
 It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
 

layrz_sdk-3.0.8/layrz_sdk/entities/__init__.py

@@ -0,0 +1,72 @@
+""" Init file """
+# Broadcast entities
+from .broadcasts import BroadcastRequest, BroadcastResponse, BroadcastResult, BroadcastStatus, OutboundService
+
+# Cases entitites
+from .cases import Case, CaseIgnoredStatus, CaseStatus, Comment, Trigger
+
+# Charts entities
+from .charts import (
+                     AreaChart,
+                     AxisConfig,
+                     BarChart,
+                     ChartAlignment,
+                     ChartColor,
+                     ChartConfiguration,
+                     ChartDataSerie,
+                     ChartDataSerieType,
+                     ChartDataType,
+                     ChartException,
+                     ChartRenderTechnology,
+                     ColumnChart,
+                     HTMLChart,
+                     LineChart,
+                     MapCenterType,
+                     MapChart,
+                     MapPoint,
+                     NumberChart,
+                     PieChart,
+                     RadarChart,
+                     RadialBarChart,
+                     ScatterChart,
+                     ScatterSerie,
+                     ScatterSerieItem,
+                     TableChart,
+                     TableHeader,
+                     TableRow,
+                     TimelineChart,
+                     TimelineSerie,
+                     TimelineSerieItem,
+                     get_color_list,
+)
+
+# Checkpoints entities
+from .checkpoints import Checkpoint, Geofence, Waypoint
+
+# Events entities
+from .events import Event
+
+# Formatting entities
+from .formatting import TextAlignment
+
+# General entities
+from .general import Asset, AssetOperationMode, CustomField, Device, Sensor, User
+
+# REPCOM entities
+from .repcom import Transaction
+
+# Reports entities
+from .reports import (
+                     CustomReportPage,
+                     Report,
+                     ReportCol,
+                     ReportConfiguration,
+                     ReportDataType,
+                     ReportFormat,
+                     ReportHeader,
+                     ReportPage,
+                     ReportRow,
+)
+
+# Telemetry entities
+from .telemetry import Message, Position

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/broadcasts/request.py

@@ -1,4 +1,5 @@
 """ Broadcast Result Request data """
+from typing import Dict, List, Self
 
 
 class BroadcastRequest:
@@ -10,19 +11,19 @@ class BroadcastRequest:
     - raw : Raw data
   """
 
-  def __init__(self, json: dict | list, raw: str) -> None:
+  def __init__(self: Self, json: Dict | List, raw: str) -> None:
     self.json = json
     self.raw = raw
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastRequest(json={self.json}, raw={self.raw})'
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/broadcasts/response.py

@@ -1,4 +1,5 @@
 """ Broadcast Result Response data """
+from typing import Dict, List, Self
 
 
 class BroadcastResponse:
@@ -10,19 +11,19 @@ class BroadcastResponse:
     - raw (str): Raw data
   """
 
-  def __init__(self, json: dict | list, raw: str) -> None:
+  def __init__(self: Self, json: Dict | List, raw: str) -> str | None | bool:
     self.json = json
     self.raw = raw
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastResponse(json={self.json}, raw={self.raw})'
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/broadcasts/result.py

@@ -1,5 +1,6 @@
 """ Broadcast result """
 from datetime import datetime
+from typing import Self
 
 from .request import BroadcastRequest
 from .response import BroadcastResponse
@@ -20,14 +21,14 @@ class BroadcastResult:
   """
 
   def __init__(
-    self,
+    self: Self,
     service_id: int,
     asset_id: int,
     status: BroadcastStatus,
     request: BroadcastRequest,
     response: BroadcastResponse,
     submitted_at: datetime,
-  ) -> None:
+  ) -> str | None | bool:
     self.service_id = service_id
     self.asset_id = asset_id
     self.status = status
@@ -36,15 +37,15 @@ class BroadcastResult:
     self.submitted_at = submitted_at
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastResult(service_id={self.service_id}, asset_id={self.asset_id}, status={self.status}, ' +\
            f'request={self.request}, response={self.response}, submitted_at={self.submitted_at})'
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/broadcasts/service.py

@@ -1,4 +1,5 @@
 """ Service entity """
+from typing import Self
 
 
 class OutboundService:
@@ -10,19 +11,19 @@ class OutboundService:
     - name : Service Name
   """
 
-  def __init__(self, pk: int, name: str) -> None:
+  def __init__(self: Self, pk: int, name: str) -> str | None | bool:
     self.pk = pk
     self.name = name
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'OutboundService(pk={self.pk}, name={self.name})'
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/broadcasts/status.py

@@ -1,5 +1,6 @@
 """ Broadcast result Status """
 from enum import Enum
+from typing import Self
 
 
 class BroadcastStatus(Enum):
@@ -12,14 +13,14 @@ class BroadcastStatus(Enum):
   DISCONNECTED = 'DISCONNECTED'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/cases/case.py

@@ -2,6 +2,7 @@
 
 from datetime import datetime
 from enum import Enum
+from typing import Self
 
 from .trigger import Trigger
 
@@ -13,15 +14,15 @@ class CaseStatus(Enum):
   CLOSED = 'CLOSED'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
@@ -36,15 +37,15 @@ class CaseIgnoredStatus(Enum):
   AUTO = 'AUTO'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
@@ -66,7 +67,7 @@ class Case:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     trigger: Trigger,
     asset_id: int,
@@ -88,29 +89,29 @@ class Case:
     self._sequence = sequence
     self.ignored_status = ignored_status
 
-  def get_sequence(self) -> str:
+  def get_sequence(self: Self) -> str | None | bool:
     """ Sequence getter """
     if self._sequence is not None:
       return f'{self.trigger.code}/{self._sequence}'
     else:
       return f'GENERIC/{self.pk}'
 
-  def set_sequence(self, sequence: int) -> None:
+  def set_sequence(self: Self, sequence: int) -> None:
     """ Sequence setter """
     self._sequence = sequence
 
   sequence = property(get_sequence, set_sequence)
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Case(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, ' +\
            f'comments={len(self.comments)}, opened_at={self.opened_at}, closed_at={self.closed_at})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/cases/comment.py

@@ -1,5 +1,6 @@
 """ Comment entity """
 from datetime import datetime
+from typing import Self
 
 from layrz_sdk.entities.general.user import User
 
@@ -15,7 +16,7 @@ class Comment:
     - submitted_at : Date of comment submission
   """
 
-  def __init__(self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
+  def __init__(self: Self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
     """ Constructor """
     self.pk = pk
     self.content = content
@@ -23,14 +24,14 @@ class Comment:
     self.submitted_at = submitted_at
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Comment(pk={self.pk}, content="{self.content}", user={self.user}, submitted_at={self.submitted_at})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/cases/trigger.py

@@ -1,4 +1,5 @@
 """ Trigger entity """
+from typing import Self
 
 
 class Trigger:
@@ -11,21 +12,21 @@ class Trigger:
     - code : Trigger code
   """
 
-  def __init__(self, pk: int, name: str, code: str) -> None:
+  def __init__(self: Self, pk: int, name: str, code: str) -> None:
     """ Constructor """
     self.pk = pk
     self.name = name
     self.code = code
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Trigger(pk={self.pk}, name="{self.name}", code="{self.code}")'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/__init__.py

@@ -3,7 +3,7 @@ from .alignment import ChartAlignment
 from .bar import BarChart
 from .color import ChartColor, get_color_list
 from .column import ColumnChart
-from .configuration import ChartConfiguration, AxisConfig
+from .configuration import AxisConfig, ChartConfiguration
 from .data_type import ChartDataType
 from .exceptions import ChartException
 from .html import HTMLChart

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/alignment.py

@@ -1,5 +1,6 @@
 """ Chart alignment """
 from enum import Enum
+from typing import Self
 
 
 class ChartAlignment(Enum):
@@ -11,14 +12,14 @@ class ChartAlignment(Enum):
   RIGHT = 'right'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'ChartAlignment.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/bar.py

@@ -1,4 +1,6 @@
 """ Bar chart """
+from typing import Any, List, Self
+
 from .alignment import ChartAlignment
 from .configuration import AxisConfig
 from .exceptions import ChartException
@@ -13,9 +15,9 @@ class BarChart:
   """
 
   def __init__(
-    self,
+    self: Self,
     x_axis: ChartDataSerie,
-    y_axis: list[ChartDataSerie],
+    y_axis: List[ChartDataSerie],
     title: str = 'Chart',
     align: ChartAlignment = ChartAlignment.CENTER,
     x_axis_config: AxisConfig = None,
@@ -66,9 +68,9 @@ class BarChart:
     self.y_axis_config = y_axis_config
 
   def render(
-    self,
+    self: Self,
     technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> dict:
+  ) -> Any:
     """
     Render chart to a graphic Library.
     We have two graphic libraries: GRAPHIC and APEXCHARTS.
@@ -103,7 +105,7 @@ class BarChart:
       'configuration': [f'Unsupported rendering technology {technology.name}'],
     }
 
-  def _render_syncfusion_flutter_charts(self) -> list[dict]:
+  def _render_syncfusion_flutter_charts(self: Self) -> Any:
     """
     Converts the configuration of the chart to Syncfusion Flutter Charts.
     """
@@ -139,7 +141,7 @@ class BarChart:
       },
     }
 
-  def _render_graphic(self) -> list[dict]:
+  def _render_graphic(self: Self) -> Any:
     """
     Converts the configuration of the chart to Flutter library graphic.
     """
@@ -158,7 +160,7 @@ class BarChart:
 
     return series
 
-  def _render_apexcharts(self) -> dict:
+  def _render_apexcharts(self: Self) -> Any:
     """
     Converts the configuration of the chart to Javascript library ApexCharts.
     """

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/color.py

@@ -1,5 +1,6 @@
 """ Chart alignment """
 from enum import Enum
+from typing import Any, Self
 
 
 class ChartColor(Enum):
@@ -17,19 +18,19 @@ class ChartColor(Enum):
   LIME = '#CDDC39'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'ChartColor.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
 
-def get_color_list() -> list[str]:
+def get_color_list() -> Any:
   """ Get all colors """
   return [color.value for color in ChartColor]

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/column.py

@@ -1,4 +1,6 @@
 """ Column chart """
+from typing import Any, List, Self
+
 from layrz_sdk.helpers import convert_to_rgba
 
 from .alignment import ChartAlignment
@@ -16,9 +18,9 @@ class ColumnChart:
   """
 
   def __init__(
-    self,
+    self: Self,
     x_axis: ChartDataSerie,
-    y_axis: list[ChartDataSerie],
+    y_axis: List[ChartDataSerie],
     title: str = 'Chart',
     align: ChartAlignment = ChartAlignment.CENTER,
     x_axis_config: AxisConfig = None,
@@ -69,9 +71,9 @@ class ColumnChart:
     self.y_axis_config = y_axis_config
 
   def render(
-    self,
+    self: Self,
     technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> dict:
+  ) -> Any:
     """
     Render chart to a graphic Library.
     We have two graphic libraries: GRAPHIC and APEXCHARTS.
@@ -106,7 +108,7 @@ class ColumnChart:
       'configuration': [f'Unsupported {technology}'],
     }
 
-  def _render_syncfusion_flutter_charts(self) -> dict:
+  def _render_syncfusion_flutter_charts(self: Self) -> Any:
     """
     Converts the configuration of the chart to Syncfusion Flutter Charts.
     """
@@ -142,7 +144,7 @@ class ColumnChart:
       },
     }
 
-  def _render_graphic(self) -> list[dict]:
+  def _render_graphic(self: Self) -> Any:
     """
     Converts the configuration of the chart to Flutter library graphic.
     """
@@ -161,7 +163,7 @@ class ColumnChart:
 
     return series
 
-  def _render_apexcharts(self) -> dict:
+  def _render_apexcharts(self: Self) -> Any:
     """
     Converts the configuration of the chart to Javascript library ApexCharts.
     """

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/configuration.py

@@ -1,4 +1,6 @@
 """ Charts entities """
+from typing import Self
+
 from .data_type import ChartDataType
 
 
@@ -7,21 +9,21 @@ class ChartConfiguration:
   Chart configuration
   """
 
-  def __init__(self, name: str, description: str) -> None:
+  def __init__(self: Self, name: str, description: str) -> None:
     """ Constructor """
     self.name = name
     self.description = description
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'ChartConfiguration(name="{self.name}")'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
@@ -30,11 +32,11 @@ class AxisConfig:
   """ Axis configuration """
 
   def __init__(
-    self,
+    self: Self,
     label: str = '',
     measure_unit: str = '',
-    min_value: int | float = None,
-    max_value: int | float = None,
+    min_value: float = None,
+    max_value: float = None,
     data_type: ChartDataType = ChartDataType.DATETIME,
   ) -> None:
     """

{layrz_sdk-3.0.6 → layrz_sdk-3.0.8}/layrz_sdk/entities/charts/data_type.py

@@ -1,5 +1,6 @@
 """ Chart Data type """
 from enum import Enum
+from typing import Self
 
 
 class ChartDataType(Enum):
@@ -11,14 +12,14 @@ class ChartDataType(Enum):
   NUMBER = 'NUMBER'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'ChartDataType.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable