layrz-sdk 3.0.13__py3-none-any.whl → 3.1.0__py3-none-any.whl

layrz_sdk/entities/{reports/format.py → report_format.py}

@@ -1,26 +1,27 @@
-"""Report formats"""
-
-from enum import Enum
-
-
-class ReportFormat(Enum):
-  """
-  Report format definition.
-  """
-
-  MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
-  JSON = 'JSON'
-  PDF = 'PDF'
-
-  @property
-  def _readable(self) -> str:
-    """Readable"""
-    return f'ReportFormat.{self.value}'
-
-  def __str__(self) -> str:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str:
-    """Readable property"""
-    return self._readable
+"""Report formats"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ReportFormat(Enum):
+  """
+  Report format definition.
+  """
+
+  MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
+  JSON = 'JSON'
+  PDF = 'PDF'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ReportFormat.{self.value}'

layrz_sdk/entities/report_header.py

@@ -0,0 +1,43 @@
+"""Report header"""
+
+import warnings
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+from .text_alignment import TextAlignment
+
+
+class ReportHeader(BaseModel):
+  """Report header entity"""
+
+  content: Any = Field(description='Header content')
+  color: str = Field(description='Header color', default='#ffffff')
+  text_color: Optional[str] = Field(description='Header text color', default=None)
+  align: TextAlignment = Field(description='Header text alignment', default=TextAlignment.CENTER)
+  bold: bool = Field(description='Bold text', default=False)
+  width: Optional[int] = Field(description='Header width', default=None)
+
+  @field_validator('text_color', mode='before')
+  def _validate_text_color(cls, value: Any) -> Any:
+    """Validate text color"""
+    if value is not None:
+      warnings.warn(
+        'text_color is deprecated, the algorithm will calculate the rigth text color instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value
+
+  @field_validator('width', mode='before')
+  def _validate_width(cls, value: Any) -> Any:
+    """Validate width"""
+    if value is not None:
+      warnings.warn(
+        'width is deprecated, the algorithm will calculate the rigth width instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value

layrz_sdk/entities/report_page.py

@@ -0,0 +1,17 @@
+"""Report page"""
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from .report_header import ReportHeader
+from .report_row import ReportRow
+
+
+class ReportPage(BaseModel):
+  """Report page definition"""
+
+  name: str = Field(description='Name of the page. Length should be less than 60 characters')
+  headers: List[ReportHeader] = Field(description='List of report headers', default_factory=list)
+  rows: List[ReportRow] = Field(description='List of report rows', default_factory=list)
+  freeze_header: bool = Field(description='Freeze header', default=False)

layrz_sdk/entities/report_row.py

@@ -0,0 +1,28 @@
+"""Report row"""
+
+import warnings
+from typing import Any, List, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+from .report_col import ReportCol
+
+
+class ReportRow(BaseModel):
+  """Report row definition"""
+
+  content: List[ReportCol] = Field(description='List of report columns', default_factory=list)
+  height: Optional[float] = Field(description='Row height', default=None)
+  compact: bool = Field(description='Compact mode', default=False)
+
+  @field_validator('height', mode='before')
+  def _validate_height(cls, value: Any) -> Any:
+    """Validate height"""
+    if value is not None:
+      warnings.warn(
+        'height is deprecated, the algorithm will calculate the rigth text color instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value

layrz_sdk/entities/sensor.py

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

layrz_sdk/entities/{formatting/text_align.py → text_alignment.py}

@@ -1,25 +1,26 @@
-"""Text alignment"""
-
-from enum import Enum
-
-
-class TextAlignment(Enum):
-  """Text alignment enum definition"""
-
-  CENTER = 'center'
-  LEFT = 'left'
-  RIGHT = 'right'
-  JUSTIFY = 'justify'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'TextAlignment.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
+"""Text alignment"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TextAlignment(Enum):
+  """Text alignment enum definition"""
+
+  CENTER = 'center'
+  LEFT = 'left'
+  RIGHT = 'right'
+  JUSTIFY = 'justify'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'TextAlignment.{self.value}'

layrz_sdk/entities/trigger.py

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

layrz_sdk/entities/user.py

@@ -0,0 +1,10 @@
+"""User entity"""
+
+from pydantic import BaseModel, Field
+
+
+class User(BaseModel):
+  """User entity"""
+
+  pk: int = Field(description='Defines the primary key of the user')
+  name: str = Field(description='Defines the name of the user')

layrz_sdk/entities/waypoint.py

@@ -0,0 +1,18 @@
+"""Waypoint entity"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .geofence import Geofence
+
+
+class Waypoint(BaseModel):
+  """Waypoint entity definition"""
+
+  pk: int = Field(description='Waypoint ID')
+  geofence: Geofence = Field(description='Geofence object')
+  start_at: datetime = Field(description='Waypoint start date')
+  end_at: datetime = Field(description='Waypoint end date')
+  sequence_real: int = Field(description='Real sequence number')
+  sequence_ideal: int = Field(description='Ideal sequence number')

layrz_sdk/helpers/__init__.py

@@ -1,2 +1,8 @@
-""" Layrz SDK Helpers """
-from .color import convert_to_rgba, use_black
+"""Layrz SDK Helpers"""
+
+from .color import convert_to_rgba, use_black
+
+__all__ = [
+  'convert_to_rgba',
+  'use_black',
+]

layrz_sdk/helpers/color.py

@@ -1,45 +1,41 @@
-"""
-Color helpers
-"""
-
-from typing import Tuple
-
-
-def convert_to_rgba(hex_color: str) -> Tuple[int, int, int, int]:
-  """
-  Convert Hex (or Hexa) color to RGB (or RGBA) color
-  Arguments
-  ---------
-    hex_color (str): Hex (or Hexa) color
-  Returns
-  -------
-    tuple(r,g,b,a): Combination of colors. When the argument (hex_color) is Hex, the alpha channel is set to 1.
-  """
-
-  if not hex_color.startswith('#'):
-    raise ValueError('Invalid color, must starts with #')
-
-  hex_color = hex_color.replace('#', '')
-  if len(hex_color) == 6:
-    return tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4)) + (1,)
-
-  return tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4, 6))
-
-
-def use_black(color: str) -> bool:
-  """
-  Use black
-  Will return when the background color works well with black text color.
-  Note: This method is not 100% accurate and will not work with alpha channel (Hexa color)
-
-  Arguments
-  ---------
-    color (str): Hex color
-
-  Returns
-  -------
-    boolean: True if use black
-  """
-  rgb = convert_to_rgba(color)
-  a = 1 - (0.299 * rgb[0] + 0.587 * rgb[1] + 0.114 * rgb[2]) / 255
-  return a < 0.5
+"""Color helpers"""
+
+from typing import Tuple, TypeAlias, cast
+
+Color: TypeAlias = Tuple[int, int, int, int]
+
+
+def convert_to_rgba(hex_color: str) -> Color:
+  """
+  Convert Hex (or Hexa) color to RGB (or RGBA) color
+  :param hex_color: Hex color
+  :type hex_color: str
+  :return: RGB or RGBA color
+  :rtype: tuple
+  :raises ValueError: If the color is invalid
+  """
+
+  if not hex_color.startswith('#'):
+    raise ValueError('Invalid color, must starts with #')
+
+  hex_color = hex_color.replace('#', '')
+  if len(hex_color) == 6:
+    return cast(Color, tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4)) + (1,))
+
+  return cast(Color, tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4, 6)))
+
+
+def use_black(color: str) -> bool:
+  """
+  Use black
+  Will return when the background color works well with black text color.
+  Note: This method is not 100% accurate and will not work with alpha channel (Hexa color)
+  :param color: Hex color
+  :type color: str
+  :return: True if the color works well with black text color
+  :rtype: bool
+  :raises ValueError: If the color is invalid
+  """
+  rgb = convert_to_rgba(color)
+  a = 1 - (0.299 * rgb[0] + 0.587 * rgb[1] + 0.114 * rgb[2]) / 255
+  return a < 0.5

layrz_sdk/lcl/__init__.py

@@ -1,2 +1,7 @@
-""" Layrz Compute Language (LCL) SDK """
-from .core import LclCore
+"""Layrz Compute Language (LCL) SDK"""
+
+from .core import LclCore
+
+__all__ = [
+  'LclCore',
+]