layrz-sdk 3.1.12__py3-none-any.whl → 3.1.13__py3-none-any.whl

layrz_sdk/entities/charts/timeline_chart.py

@@ -1,79 +1,79 @@
-"""Timeline chart entities"""
-
-import sys
-from typing import Any
-
-from pydantic import BaseModel, Field
-
-from .chart_alignment import ChartAlignment
-from .timeline_serie import TimelineSerie
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class TimelineChart(BaseModel):
-  """Timeline chart configuration"""
-
-  series: list[TimelineSerie] = Field(description='List of series to be displayed in the chart', default_factory=list)
-  title: str = Field(description='Title of the chart', default='Chart')
-  align: ChartAlignment = Field(description='Alignment of the chart', default=ChartAlignment.CENTER)
-
-  def render(self: Self) -> dict[str, Any]:
-    """
-    Render chart to a graphic Library.
-
-    :param technology: The technology to use to render the chart.
-    :type technology: ChartRenderTechnology
-
-    :return: The configuration of the chart.
-    :rtype: dict[str, Any]
-    """
-    return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
-
-  def _render_apexcharts(self: Self) -> dict[str, Any]:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-
-    for serie in self.series:
-      data = []
-
-      for item in serie.data:
-        data.append(
-          {
-            'x': item.name,
-            'y': [item.start_at.timestamp() * 1000, item.end_at.timestamp() * 1000],
-            'fillColor': item.color,
-          }
-        )
-
-      series.append({'name': serie.label, 'data': data})
-
-    config = {
-      'series': series,
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'chart': {
-        'type': 'rangeBar',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-      'xaxis': {'type': 'datetime'},
-      'plotOptions': {
-        'bar': {
-          'horizontal': True,
-        }
-      },
-      'dataLabels': {'enabled': True},
-    }
-
-    return config
+"""Timeline chart entities"""
+
+import sys
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .chart_alignment import ChartAlignment
+from .timeline_serie import TimelineSerie
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TimelineChart(BaseModel):
+  """Timeline chart configuration"""
+
+  series: list[TimelineSerie] = Field(description='List of series to be displayed in the chart', default_factory=list)
+  title: str = Field(description='Title of the chart', default='Chart')
+  align: ChartAlignment = Field(description='Alignment of the chart', default=ChartAlignment.CENTER)
+
+  def render(self: Self) -> dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+
+    :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
+    :return: The configuration of the chart.
+    :rtype: dict[str, Any]
+    """
+    return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
+
+  def _render_apexcharts(self: Self) -> dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+
+    for serie in self.series:
+      data = []
+
+      for item in serie.data:
+        data.append(
+          {
+            'x': item.name,
+            'y': [item.start_at.timestamp() * 1000, item.end_at.timestamp() * 1000],
+            'fillColor': item.color,
+          }
+        )
+
+      series.append({'name': serie.label, 'data': data})
+
+    config = {
+      'series': series,
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'chart': {
+        'type': 'rangeBar',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+      'xaxis': {'type': 'datetime'},
+      'plotOptions': {
+        'bar': {
+          'horizontal': True,
+        }
+      },
+      'dataLabels': {'enabled': True},
+    }
+
+    return config

layrz_sdk/entities/charts/timeline_serie.py

@@ -1,10 +1,10 @@
-from pydantic import BaseModel, Field
-
-from .timeline_serie_item import TimelineSerieItem
-
-
-class TimelineSerie(BaseModel):
-  """Chart Data Serie for Timeline charts"""
-
-  data: list[TimelineSerieItem] = Field(description='List of data points', default_factory=list)
-  label: str = Field(description='Label of the serie')
+from pydantic import BaseModel, Field
+
+from .timeline_serie_item import TimelineSerieItem
+
+
+class TimelineSerie(BaseModel):
+  """Chart Data Serie for Timeline charts"""
+
+  data: list[TimelineSerieItem] = Field(description='List of data points', default_factory=list)
+  label: str = Field(description='Label of the serie')

layrz_sdk/entities/charts/timeline_serie_item.py

@@ -1,12 +1,12 @@
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-
-class TimelineSerieItem(BaseModel):
-  """Chart Data Serie Item for Timeline Charts"""
-
-  name: str = Field(description='Name of the item')
-  start_at: datetime = Field(description='Start date of the item')
-  end_at: datetime = Field(description='End date of the item')
-  color: str = Field(description='Color of the item')
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class TimelineSerieItem(BaseModel):
+  """Chart Data Serie Item for Timeline Charts"""
+
+  name: str = Field(description='Name of the item')
+  start_at: datetime = Field(description='Start date of the item')
+  end_at: datetime = Field(description='End date of the item')
+  color: str = Field(description='Color of the item')

layrz_sdk/entities/checkpoint.py

@@ -1,17 +1,17 @@
-"""Checkpoints entitites"""
-
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-from .waypoint import Waypoint
-
-
-class Checkpoint(BaseModel):
-  """Checkpoint entity definition"""
-
-  pk: int = Field(description='Checkpoint ID')
-  asset_id: int = Field(description='Asset ID')
-  waypoints: list[Waypoint] = Field(description='List of waypoints', default_factory=list)
-  start_at: datetime = Field(description='Checkpoint start date')
-  end_at: datetime = Field(description='Checkpoint end date')
+"""Checkpoints entitites"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .waypoint import Waypoint
+
+
+class Checkpoint(BaseModel):
+  """Checkpoint entity definition"""
+
+  pk: int = Field(description='Checkpoint ID')
+  asset_id: int = Field(description='Asset ID')
+  waypoints: list[Waypoint] = Field(description='List of waypoints', default_factory=list)
+  start_at: datetime = Field(description='Checkpoint start date')
+  end_at: datetime = Field(description='Checkpoint end date')

layrz_sdk/entities/comment.py

@@ -1,16 +1,16 @@
-"""Comment entity"""
-
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-from .user import User
-
-
-class Comment(BaseModel):
-  """Comment entity"""
-
-  pk: int = Field(description='Comment ID')
-  content: str = Field(description='Comment content')
-  user: User = Field(description='Operator/User what commented the case')
-  submitted_at: datetime = Field(description='Date of comment submission')
+"""Comment entity"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .user import User
+
+
+class Comment(BaseModel):
+  """Comment entity"""
+
+  pk: int = Field(description='Comment ID')
+  content: str = Field(description='Comment content')
+  user: User = Field(description='Operator/User what commented the case')
+  submitted_at: datetime = Field(description='Date of comment submission')

layrz_sdk/entities/custom_field.py

@@ -1,10 +1,10 @@
-"""Custom Field entitiy"""
-
-from pydantic import BaseModel, Field
-
-
-class CustomField(BaseModel):
-  """Custom field definition"""
-
-  name: str = Field(description='Defines the name of the custom field')
-  value: str = Field(description='Defines the value of the custom field')
+"""Custom Field entitiy"""
+
+from pydantic import BaseModel, Field
+
+
+class CustomField(BaseModel):
+  """Custom field definition"""
+
+  name: str = Field(description='Defines the name of the custom field')
+  value: str = Field(description='Defines the value of the custom field')

layrz_sdk/entities/custom_report_page.py

@@ -1,16 +1,40 @@
-from collections.abc import Callable
-
-from pydantic import BaseModel, Field
-from xlsxwriter.worksheet import Worksheet
-
-
-class CustomReportPage(BaseModel):
-  """
-  Custom report page
-  Basically it's a wrapper of the `xlswriter` worksheet that uses a function to construct the page
-  """
-
-  name: str = Field(description='Name of the page. Length should be less than 60 characters')
-  builder: Callable[[Worksheet], None] = Field(
-    description='Function to build the page. The only argument is the worksheet object',
-  )
+from collections.abc import Callable
+from typing import Any, Protocol, runtime_checkable
+
+from pydantic import BaseModel, ConfigDict, Field
+from xlsxwriter.worksheet import Worksheet
+
+
+@runtime_checkable
+class BuilderFunction(Protocol):
+  """
+  Protocol for the builder function.
+  """
+
+  def __call__(self, *, sheet: Worksheet, **kwargs: Any) -> None: ...
+
+
+class CustomReportPage(BaseModel):
+  """
+  Custom report page
+  Basically it's a wrapper of the `xlswriter` worksheet that uses a function to construct the page
+  """
+
+  model_config = ConfigDict(
+    from_attributes=True,
+    arbitrary_types_allowed=True,
+  )
+
+  name: str = Field(description='Name of the page. Length should be less than 60 characters')
+  builder: Callable[[Worksheet], None] | None = Field(
+    description=('Function to build the page. The only argument is the worksheet object'),
+    default=None,
+  )
+  extended_builder: BuilderFunction | None = Field(
+    description=(
+      'Function to build the page. The first argument is the worksheet object, '
+      'and the rest are the kwargs to give support for the builder function.'
+      '\n Currently, the only supported kwarg is `workbook` which is the workbook object'
+    ),
+    default=None,
+  )

layrz_sdk/entities/device.py

@@ -1,13 +1,13 @@
-"""Device entitiy"""
-
-from pydantic import BaseModel, Field
-
-
-class Device(BaseModel):
-  """Device entity"""
-
-  pk: int = Field(description='Defines the primary key of the device')
-  name: str = Field(description='Defines the name of the device')
-  ident: str = Field(description='Defines the identifier of the device')
-  protocol: str = Field(description='Defines the protocol of the device')
-  is_primary: bool = Field(default=False, description='Defines if the device is the primary device')
+"""Device entitiy"""
+
+from pydantic import BaseModel, Field
+
+
+class Device(BaseModel):
+  """Device entity"""
+
+  pk: int = Field(description='Defines the primary key of the device')
+  name: str = Field(description='Defines the name of the device')
+  ident: str = Field(description='Defines the identifier of the device')
+  protocol: str = Field(description='Defines the protocol of the device')
+  is_primary: bool = Field(default=False, description='Defines if the device is the primary device')

layrz_sdk/entities/event.py

@@ -1,23 +1,23 @@
-"""Event entity"""
-
-from datetime import datetime
-from typing import Optional
-
-from pydantic import BaseModel, Field
-
-from .geofence import Geofence
-from .message import Message
-from .presence_type import PresenceType
-from .trigger import Trigger
-
-
-class Event(BaseModel):
-  """Event entity definition"""
-
-  pk: int = Field(description='Event ID')
-  trigger: Trigger = Field(description='Event trigger')
-  asset_id: int = Field(description='Asset ID')
-  message: Message = Field(description='Message')
-  activated_at: datetime = Field(description='Event activation date')
-  geofence: Optional[Geofence] = Field(default=None, description='Geofence object')
-  presence_type: Optional[PresenceType] = Field(default=None, description='Presence type object')
+"""Event entity"""
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from .geofence import Geofence
+from .message import Message
+from .presence_type import PresenceType
+from .trigger import Trigger
+
+
+class Event(BaseModel):
+  """Event entity definition"""
+
+  pk: int = Field(description='Event ID')
+  trigger: Trigger = Field(description='Event trigger')
+  asset_id: int = Field(description='Asset ID')
+  message: Message = Field(description='Message')
+  activated_at: datetime = Field(description='Event activation date')
+  geofence: Optional[Geofence] = Field(default=None, description='Geofence object')
+  presence_type: Optional[PresenceType] = Field(default=None, description='Presence type object')

layrz_sdk/entities/geofence.py

@@ -1,11 +1,11 @@
-"""Geofence entity"""
-
-from pydantic import BaseModel, Field
-
-
-class Geofence(BaseModel):
-  """Geofence entity"""
-
-  pk: int = Field(description='Defines the primary key of the geofence')
-  name: str = Field(description='Defines the name of the geofence')
-  color: str = Field(description='Defines the color of the geofence')
+"""Geofence entity"""
+
+from pydantic import BaseModel, Field
+
+
+class Geofence(BaseModel):
+  """Geofence entity"""
+
+  pk: int = Field(description='Defines the primary key of the geofence')
+  name: str = Field(description='Defines the name of the geofence')
+  color: str = Field(description='Defines the color of the geofence')

layrz_sdk/entities/last_message.py

@@ -1,12 +1,12 @@
-"""LastMessage entity"""
-
-from pydantic import BaseModel, Field
-
-from .asset import Asset
-from .message import Message
-
-
-class LastMessage(Message, BaseModel):
-  """LastMessage definition"""
-
-  asset: Asset = Field(description='Defines the asset of the last message')
+"""LastMessage entity"""
+
+from pydantic import BaseModel, Field
+
+from .asset import Asset
+from .message import Message
+
+
+class LastMessage(Message, BaseModel):
+  """LastMessage definition"""
+
+  asset: Asset = Field(description='Defines the asset of the last message')

layrz_sdk/entities/message.py

@@ -1,23 +1,23 @@
-"""Message entity"""
-
-from datetime import datetime
-from typing import Any, TypeAlias
-
-from pydantic import BaseModel, Field
-
-from layrz_sdk.constants import UTC
-
-from .position import Position
-
-PayloadType: TypeAlias = dict[str, Any]
-
-
-class Message(BaseModel):
-  """Message definition"""
-
-  pk: int
-  asset_id: int
-  position: Position = Field(default_factory=lambda: Position())
-  payload: PayloadType = Field(default_factory=dict)
-  sensors: PayloadType = Field(default_factory=dict)
-  received_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
+"""Message entity"""
+
+from datetime import datetime
+from typing import Any, TypeAlias
+
+from pydantic import BaseModel, Field
+
+from layrz_sdk.constants import UTC
+
+from .position import Position
+
+PayloadType: TypeAlias = dict[str, Any]
+
+
+class Message(BaseModel):
+  """Message definition"""
+
+  pk: int
+  asset_id: int
+  position: Position = Field(default_factory=lambda: Position())
+  payload: PayloadType = Field(default_factory=dict)
+  sensors: PayloadType = Field(default_factory=dict)
+  received_at: datetime = Field(default_factory=lambda: datetime.now(UTC))

layrz_sdk/entities/outbound_service.py

@@ -1,10 +1,10 @@
-"""Service entity"""
-
-from pydantic import BaseModel, Field
-
-
-class OutboundService(BaseModel):
-  """Outbound service definition"""
-
-  pk: int = Field(description='Service ID')
-  name: str = Field(description='Service name')
+"""Service entity"""
+
+from pydantic import BaseModel, Field
+
+
+class OutboundService(BaseModel):
+  """Outbound service definition"""
+
+  pk: int = Field(description='Service ID')
+  name: str = Field(description='Service name')