layrz-sdk 3.0.14__py3-none-any.whl → 3.1.1__py3-none-any.whl

layrz_sdk/entities/charts/configuration.py

@@ -1,54 +0,0 @@
-"""Charts entities"""
-
-from .data_type import ChartDataType
-
-
-class ChartConfiguration:
-  """
-  Chart configuration
-  """
-
-  def __init__(self, name: str, description: str) -> None:
-    """Constructor"""
-    self.name = name
-    self.description = description
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'ChartConfiguration(name="{self.name}")'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-
-class AxisConfig:
-  """Axis configuration"""
-
-  def __init__(
-    self,
-    label: str = '',
-    measure_unit: str = '',
-    min_value: float = None,
-    max_value: float = None,
-    data_type: ChartDataType = ChartDataType.DATETIME,
-  ) -> None:
-    """
-    Constructor
-    ---
-    Arguments
-      - label : Label of the axis
-      - color : Color of the axis
-      - min_value : Minimum value of the axis
-      - max_value : Maximum value of the axis
-    """
-    self.label = label
-    self.measure_unit = measure_unit
-    self.min_value = min_value
-    self.max_value = max_value
-    self.data_type = data_type

layrz_sdk/entities/charts/data_type.py

@@ -1,26 +0,0 @@
-"""Chart Data type"""
-
-from enum import Enum
-
-
-class ChartDataType(Enum):
-  """
-  Chart Data Type
-  """
-
-  STRING = 'STRING'
-  DATETIME = 'DATETIME'
-  NUMBER = 'NUMBER'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'ChartDataType.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable

layrz_sdk/entities/charts/exceptions.py

@@ -1,29 +0,0 @@
-"""Chart exceptions"""
-
-
-class ChartException(BaseException):
-  """
-  Chart Exception
-  """
-
-  def __init__(self, message: str) -> None:
-    """Constructor"""
-    self._message = message
-
-  @property
-  def message(self) -> str | None | bool:
-    """Message"""
-    return self._message
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'ChartException: {self._message}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable

layrz_sdk/entities/charts/html.py

@@ -1,44 +0,0 @@
-"""HTML chart"""
-
-from typing import Any, List
-
-from .exceptions import ChartException
-
-
-class HTMLChart:
-  """
-  HTML chart configuration
-  """
-
-  def __init__(self, content: str = '<p>N/A</p>', title: str = 'Chart') -> None:
-    """
-    Constructor
-
-    Args
-    ----
-      content (str): HTML content of the chart.
-      title (str): Title of the chart.
-      align (ChartAlignment): Alignment of the chart.
-    """
-    if not isinstance(content, str):
-      raise ChartException('content must be an instance of str')
-    self.content = content
-
-    if not isinstance(title, str):
-      raise ChartException('title must be an instance of str')
-    self.title = title
-
-  def render(self) -> Any:
-    """
-    Render chart to a Javascript Library.
-    Currently only available for HTML.
-    """
-    return {'library': 'HTML', 'configuration': self._render_html()}
-
-  def _render_html(self) -> Any:
-    """
-    Converts the configuration of the chart to HTML render engine.
-    """
-    config = {'content': self.content, 'title': self.title}
-
-    return config

layrz_sdk/entities/charts/map.py

@@ -1,179 +0,0 @@
-"""Map chart"""
-
-from enum import Enum
-from typing import Any, List, Tuple
-
-from .exceptions import ChartException
-from .render_technology import ChartRenderTechnology
-
-
-class MapCenterType(Enum):
-  """
-  Map Chart center type
-  """
-
-  FIXED = 'FIXED'
-  CONTAIN = 'CONTAIN'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'BroadcastStatus.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-
-class MapPoint:
-  """Map point configuration"""
-
-  def __init__(
-    self,
-    latitude: float,
-    longitude: float,
-    label: str,
-    color: str,
-  ) -> None:
-    """
-    Constructor
-    ---
-    Arguments
-      latitude : Latitude of the point
-      longitude : Longitude of the point
-      label : Label of the point
-      color : Color of the point
-    """
-    if not isinstance(latitude, float):
-      raise ChartException('latitude must be an instance of float')
-    self.latitude = latitude
-
-    if not isinstance(longitude, float):
-      raise ChartException('longitude must be an instance of float')
-    self.longitude = longitude
-
-    if not isinstance(label, str):
-      raise ChartException('label must be an instance of str')
-    self.label = label
-
-    if not isinstance(color, str):
-      raise ChartException('color must be an instance of str')
-    self.color = color
-
-
-class MapChart:
-  """
-  Map chart configuration
-  """
-
-  def __init__(
-    self,
-    points: List[MapPoint],
-    title: str = 'Chart',
-    center: MapCenterType = MapCenterType.CONTAIN,
-    center_latlng: List[float] | Tuple[float] = None,
-  ) -> None:
-    """
-    Constructor
-    Args
-    ----
-      points : Points of the chart
-      title : Title of the chart
-      align : Alignment of the title
-    """
-    for i, point in enumerate(points):
-      if not isinstance(point, MapPoint):
-        raise ChartException(f'Point {i} must be an instance of MapPoint')
-    self.points = points
-
-    if not isinstance(title, str):
-      raise ChartException('title must be an instance of str')
-    self.title = title
-
-    if not isinstance(center, MapCenterType):
-      raise ChartException('center must be an instance of MapCenterType')
-    self.center = center
-
-    if self.center == MapCenterType.FIXED and not isinstance(center_latlng, (List, Tuple)):
-      raise ChartException('center_latlng must be an instance of list or tuple')
-    self.center_latlng = center_latlng
-
-  def render(self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER_MAP) -> Any:
-    """
-    Render chart to a graphic Library.
-    We have two graphic libraries: FLUTTER_MAP and LEAFLET.
-
-    FLUTTER_MAP is a Flutter chart library. To return this option, use the parameter use_new_definition=True.
-    LEAFLET is a Javascript chart library. This is the default option.
-    """
-    if technology == ChartRenderTechnology.FLUTTER_MAP:
-      return {
-        'library': 'FLUTTER_MAP',
-        'chart': 'MAP',
-        'configuration': self._render_flutter_map(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported {technology}'],
-    }
-
-  def _render_flutter_map(self) -> Any:
-    """
-    Converts the configuration to the chart to Flutter Map engine.
-    """
-    points = []
-
-    for point in self.points:
-      points.append(
-        {
-          'label': point.label,
-          'color': point.color,
-          'latlng': (point.latitude, point.longitude),
-        }
-      )
-
-    center = 'CONTAIN'
-
-    if self.center == MapCenterType.FIXED:
-      center = 'FIXED'
-
-    config = {
-      'points': points,
-      'center': center,
-    }
-
-    if self.center == MapCenterType.FIXED:
-      config['centerLatLng'] = self.center_latlng
-
-    return config
-
-  def _render_leaflet(self) -> Any:
-    """
-    Converts the configuration of the chart to Leaflet map engine.
-    """
-    points = []
-
-    for point in self.points:
-      points.append({'label': point.label, 'color': point.color, 'latlng': (point.latitude, point.longitude)})
-
-    center = 'CONTAIN'
-
-    if self.center == MapCenterType.FIXED:
-      center = 'FIXED'
-
-    config = {
-      'points': points,
-      'title': self.title,
-      'center': center,
-    }
-
-    if self.center == MapCenterType.FIXED:
-      config['centerLatLng'] = self.center_latlng
-
-    return config

layrz_sdk/entities/charts/number.py

@@ -1,52 +0,0 @@
-"""Number chart"""
-
-from typing import Any
-
-from .render_technology import ChartRenderTechnology
-
-
-class NumberChart:
-  """
-  Number chart configuration
-  """
-
-  def __init__(self, value: float, color: str, label: str) -> None:
-    """
-    Constructor
-
-    Arguments
-    ---
-    value : Value of the number
-    color : Color of the number
-    label : Label of the number
-    """
-    self.value = value
-    self.color = color
-    self.label = label
-
-  def render(self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER) -> Any:
-    """
-    Render chart to a graphic Library.
-    """
-    if technology == ChartRenderTechnology.FLUTTER:
-      return {
-        'library': 'FLUTTER',
-        'chart': 'NUMBER',
-        'configuration': self._render_flutter(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported {technology}'],
-    }
-
-  def _render_flutter(self) -> Any:
-    """
-    Converts the configuration of the chart to a Flutter native components.
-    """
-    return {
-      'value': self.value,
-      'color': self.color,
-      'label': self.label,
-    }

layrz_sdk/entities/charts/radar.py

@@ -1,102 +0,0 @@
-"""Radar chart"""
-
-from typing import Any, List
-
-from .alignment import ChartAlignment
-from .exceptions import ChartException
-from .serie import ChartDataSerie
-from .serie_type import ChartDataSerieType
-
-
-class RadarChart:
-  """
-  Radar chart configuration
-
-  """
-
-  def __init__(
-    self,
-    x_axis: ChartDataSerie,
-    y_axis: List[ChartDataSerie],
-    title: str = 'Chart',
-    align: ChartAlignment = ChartAlignment.CENTER,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      - x_axis : Defines the X Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - y_axis : Defines the Y Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - title : Title of the chart
-      - align : Alignment of the title
-    """
-    for i, serie in enumerate(y_axis):
-      if not isinstance(serie, ChartDataSerie):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ChartDataSerie')
-    self.y_axis = y_axis
-
-    if not isinstance(x_axis, ChartDataSerie):
-      raise ChartException('X Axis must be an instance of ChartDataSerie')
-    self.x_axis = x_axis
-
-    if not isinstance(title, str):
-      raise ChartException('title must be an instance of str')
-    self.title = title
-
-    if not isinstance(align, ChartAlignment):
-      raise ChartException('align must be an instance of ChartAlignment')
-    self.align = align
-
-  def render(self) -> Any:
-    """
-    Render chart to a Javascript Library.
-    Currently only available for ApexCharts.
-    """
-    return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
-
-  def _render_apexcharts(self) -> Any:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-
-    for serie in self.y_axis:
-      modified_serie = {'name': serie.label, 'data': serie.data}
-
-      if serie.serie_type is not ChartDataSerieType.NONE:
-        modified_serie['type'] = serie.serie_type.value
-
-      series.append(modified_serie)
-      colors.append(serie.color)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'xaxis': {
-        'categories': self.x_axis.data,
-        'type': self.x_axis.data_type.value,
-        'title': {
-          'text': self.x_axis.label,
-          'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-        },
-      },
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'chart': {
-        'type': 'radar',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-      'dataLabels': {'enabled': True},
-      'plotOptions': {'bar': {'horizontal': True, 'borderRadius': 4}},
-    }
-
-    return config

layrz_sdk/entities/charts/serie.py

@@ -1,56 +0,0 @@
-"""Chart Data Serie"""
-
-from typing import Any
-
-from .data_type import ChartDataType
-from .exceptions import ChartException
-from .serie_type import ChartDataSerieType
-
-
-class ChartDataSerie:
-  """
-  Chart Serie
-  """
-
-  def __init__(
-    self,
-    data: Any,
-    color: str = '#000000',
-    label: str = '',
-    serie_type: ChartDataSerieType = ChartDataSerieType.LINE,
-    data_type: ChartDataType = ChartDataType.NUMBER,
-    dashed: bool = False,
-  ) -> None:
-    """
-    Constructor
-
-    Args
-    ----
-      data : List of data points.
-      color : Color of the serie.
-      label : Label of the serie.
-      serie_type : Type of the serie. Only used for mixed range charts.
-      data_type : Type of the data.
-      dashed : If the serie should be dashed.
-    """
-    self.data = data
-
-    if not isinstance(color, str):
-      raise ChartException('color must be an instance of str')
-    self.color = color
-
-    if not isinstance(label, str):
-      raise ChartException('label must be an instance of str')
-    self.label = label
-
-    if not isinstance(data_type, ChartDataType):
-      raise ChartException('data_type must be an instance of ChartDataType')
-    self.data_type = data_type
-
-    if not isinstance(serie_type, ChartDataSerieType):
-      raise ChartException('serie_type must be an instance of ChartDataSerieType')
-    self.serie_type = serie_type or ChartDataSerieType.NONE
-
-    if not isinstance(dashed, bool):
-      raise ChartException('dashed must be an instance of bool')
-    self.dashed = dashed

layrz_sdk/entities/charts/serie_type.py

@@ -1,27 +0,0 @@
-"""Chart Serie type"""
-
-from enum import Enum
-
-
-class ChartDataSerieType(Enum):
-  """
-  Chart data serie type
-  """
-
-  NONE = None
-  LINE = 'line'
-  AREA = 'area'
-  SCATTER = 'scatter'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'BroadcastStatus.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable

layrz_sdk/entities/charts/table.py

@@ -1,74 +0,0 @@
-"""Number chart"""
-
-from typing import Any, List
-
-from .render_technology import ChartRenderTechnology
-
-
-class TableHeader:
-  """Table header chart configuration"""
-
-  def __init__(self, label: str, key: str) -> None:
-    """Constructor
-    ---
-    Arguments
-      - label : Label of the header
-      - key : Key of the header
-    """
-    self.label = label
-    self.key = key
-
-
-class TableRow:
-  """Table row chart configuration"""
-
-  def __init__(self, data: Any) -> None:
-    """Constructor
-    ---
-    Arguments
-      - data : Data of the row
-    """
-    self.data = data
-
-
-class TableChart:
-  """
-  Table chart configuration
-  """
-
-  def __init__(self, columns: List[TableHeader], rows: List[TableRow]) -> None:
-    """
-    Constructor
-    ---
-    Arguments
-      - columns : List of columns
-      - rows : List of rows
-    """
-    self.columns = columns
-    self.rows = rows
-
-  def render(self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER) -> Any:
-    """
-    Render chart to a graphic Library.
-    """
-    if technology == ChartRenderTechnology.FLUTTER:
-      return {
-        'library': 'FLUTTER',
-        'chart': 'TABLE',
-        'configuration': self._render_flutter(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported {technology}'],
-    }
-
-  def _render_flutter(self) -> Any:
-    """
-    Converts the configuration of the chart to a Flutter native components.
-    """
-    return {
-      'columns': [{'key': column.key, 'label': column.label} for column in self.columns],
-      'rows': [{'data': row.data} for row in self.rows],
-    }