layrz-sdk 3.1.28__tar.gz → 3.1.30__tar.gz

{layrz_sdk-3.1.28/layrz_sdk.egg-info → layrz_sdk-3.1.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.28
+Version: 3.1.30
 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>

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk/entities/__init__.py

@@ -48,6 +48,7 @@ from .custom_field import CustomField
 from .custom_report_page import CustomReportPage
 from .device import Device
 from .event import Event
+from .function import Function
 from .geofence import Geofence
 from .last_message import LastMessage
 from .message import Message

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk/entities/asset.py

@@ -20,7 +20,7 @@ from .static_position import StaticPosition
 class Asset(BaseModel):
   """Asset entity definition"""
 
-  pk: int = Field(description='Defines the primary key of the asset')
+  pk: int = Field(description='Defines the primary key of the asset', serialization_alias='id')
   name: str = Field(description='Defines the name of the asset')
   vin: str | None = Field(
     default=None,

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk/entities/broadcast/payload.py

@@ -8,6 +8,7 @@ from pydantic import BaseModel, Field
 from layrz_sdk.constants import UTC
 from layrz_sdk.entities.asset import Asset
 from layrz_sdk.entities.device import Device
+from layrz_sdk.entities.trigger import Trigger
 
 from .service import BroadcastService
 
@@ -23,9 +24,17 @@ class BroadcastPayload(BaseModel):
   }
 
   asset: Asset = Field(..., description='Asset object')
-  primary_device: Device | None = Field(None, description='Primary device object', serialization_alias='primaryDevice')
+  primary_device: Device | None = Field(
+    default=None,
+    description='Primary device object',
+    serialization_alias='primaryDevice',
+  )
+  trigger: Trigger | None = Field(
+    default=None,
+    description='Trigger object, if available',
+  )
   message_id: int | str = Field(..., description='Message ID', serialization_alias='message.id')
-  service: BroadcastService | None = Field(None, description='Broadcast service object')
+  service: BroadcastService | None = Field(default=None, description='Broadcast service object')
   position: dict[str, Any] = Field(default_factory=dict, description='Position data, if available')
   sensors: dict[str, Any] = Field(default_factory=dict, description='Sensors data, if available')
   payload: dict[str, Any] = Field(default_factory=dict, description='Payload data, if available')

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk/entities/device.py

@@ -8,7 +8,7 @@ from .modbus import ModbusConfig
 class Device(BaseModel):
   """Device entity"""
 
-  pk: int = Field(description='Defines the primary key of the device')
+  pk: int = Field(description='Defines the primary key of the device', serialization_alias='id')
   name: str = Field(description='Defines the name of the device')
   ident: str = Field(description='Defines the identifier of the device')
   protocol_id: int | None = Field(

layrz_sdk-3.1.30/layrz_sdk/entities/function.py

@@ -0,0 +1,29 @@
+"""Geofence entity"""
+
+from datetime import timedelta
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field, constr
+
+from .asset import Asset
+
+
+class Function(BaseModel):
+  """Function entity"""
+
+  pk: int = Field(description='Defines the primary key of the Function')
+  name: str = Field(description='Name of the function')
+
+  maximum_time: Optional[timedelta] = None  # DurationField → timedelta
+  minutes_delta: Optional[timedelta] = None
+
+  external_identifiers: List[constr(max_length=255)] = Field(default_factory=list)  # type: ignore
+
+  credentials: Dict[str, Any] = Field(default_factory=dict)
+
+  # Many-to-manys  ➜  list of nested DTOs
+  assets: List[Asset] = Field(default_factory=list)
+
+  # Foreign keys – normally expose only the FK id to keep the payload small.
+  owner_id: Optional[int] = None
+  algorithm_id: int

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk/entities/trigger.py

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

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.28
+Version: 3.1.30
 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>

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/layrz_sdk.egg-info/SOURCES.txt

@@ -1,15 +1,6 @@
-.gitignore
-CHANGELOG.md
-CODE_OF_CONDUCT.md
-CONTRIBUTING.md
 LICENSE
 README.md
-manual_deploy.py
 pyproject.toml
-uv.lock
-.github/workflows/checks.yml
-.github/workflows/deploy.yml
-.vscode/extensions.json
 layrz_sdk/__init__.py
 layrz_sdk/backwards.py
 layrz_sdk/constants.py
@@ -32,6 +23,7 @@ layrz_sdk/entities/custom_field.py
 layrz_sdk/entities/custom_report_page.py
 layrz_sdk/entities/device.py
 layrz_sdk/entities/event.py
+layrz_sdk/entities/function.py
 layrz_sdk/entities/geofence.py
 layrz_sdk/entities/last_message.py
 layrz_sdk/entities/message.py
@@ -100,5 +92,4 @@ layrz_sdk/helpers/__init__.py
 layrz_sdk/helpers/color.py
 layrz_sdk/lcl/__init__.py
 layrz_sdk/lcl/core.py
-tests/__init__.py
 tests/test_lcl.py

{layrz_sdk-3.1.28 → layrz_sdk-3.1.30}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.28"
+version = "3.1.30"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}

layrz_sdk-3.1.28/.github/workflows/checks.yml

@@ -1,50 +0,0 @@
-name: "Checks before merging"
-
-on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-    branches:
-      - '*'
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-    
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Lint
-        run: |
-          uv sync --only-group dev
-          uv run ruff check
-          uv run mypy .
-
-  uniitest:
-    needs: lint
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Install dependencies
-        run: |
-          uv sync
-          uv run pytest ./tests/
-

layrz_sdk-3.1.28/.github/workflows/deploy.yml

@@ -1,32 +0,0 @@
-name: "Deploy package"
-
-on:
-  push:
-    branches: [ "main" ]
-
-jobs:
-  build:
-    permissions:
-      id-token: write
-      contents: read
-      repository-projects: read
-      packages: read
-
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Build and upload
-        run: |
-          uv venv --python 3.13
-          uv sync --only-group dev
-          uv run python -m build
-          uv run python -m twine upload -u ${{ secrets.LAYRZ_PYPI_USERNAME }} -p ${{ secrets.LAYRZ_PYPI_PASSWORD }} dist/*

layrz_sdk-3.1.28/.gitignore

@@ -1,19 +0,0 @@
-/dist
-/build
-/*.egg-info
-/.pypirc
-/test.py
-/**/*.pyc
-/.venv
-/site
-
-/**/*/__pycache__
-
-tests.py
-*.xlsx
-
-.ruff_cache
-.mypy_cache
-.pytest_cache
-
-.env

layrz_sdk-3.1.28/.vscode/extensions.json

@@ -1,9 +0,0 @@
-{
-  "recommendations": [
-    "ms-python.python",
-    "charliermarsh.ruff",
-    "ms-python.vscode-pylance",
-    "njpwerner.autodocstring",
-    "oderwat.indent-rainbow"
-  ]
-}

layrz_sdk-3.1.28/CHANGELOG.md

@@ -1,433 +0,0 @@
-# Changelog
-
-## 3.1.27
-
-- Fixes on `ChartDataSerieType` that can have a `None` value, removed str inheritance to avoid issues
-
-## 3.1.26
-
-- Reverted StrEnum in favor to str + Enum due to compatibility issues
-
-## 3.1.25
-
-- Added `AssetConstants` class to hold constants related to assets on sensors, triggers and functions.
-
-## 3.1.24
-## 3.1.23
-## 3.1.22
-
-- Backwards compatibility for `StrEnum` in Python 3.11 and below, now using `layrz_sdk.backwards.StrEnum` for versions below 3.11.
-
-## 3.1.21
-
-- Moved all enums to `StrEnum` and added compatibility for Python 3.11 and below.
-
-## 3.1.20
-
-- Fixed condition of `StrEnum` on Python 3.11, for versions below 3.11 it will use `strenum.StrEnum` instead of `enum.StrEnum`
-
-## 3.1.19
-
-- Added serializers for messages
-
-## 3.1.18
-
-- Fixes
-
-## 3.1.17
-
-- Fixes
-
-## 3.1.16
-
-- Added `primary_id` into `Asset`
-
-## 3.1.15
-
-- Added some parameters on `Asset` and `Device` classes
-- Added `AssetMessage` and `DeviceMessage` classes to handle messages related to assets and devices 
-
-## 3.1.14
-
-- Some changes related to the `Case` entity
-
-## 3.1.12
-
-- Adjustment of all typings
-
-## 3.1.11
-
-- Fixes on data casting in `Message` class
-
-## 3.1.10
-
-- Updated docstrings to provide more information about types and usage
-
-## 3.1.9
-
-- Changed `json` to `parsed` on `BroadcastResponse` and `BroadcastRequest` to avoid confusion with the `json` property from `pydantic.BaseModel`
-
-## 3.1.8
-
-- Replaced `str` in favor of using `Path` object to manage paths on `Report` export methods
-
-## 3.1.7
-
-- Removed validation of asset type `SINGLE`
-
-## 3.1.6
-
-- Fixes on model validate on `Asset` class
-
-## 3.1.5
-
-- Changed `width` on `ReportHeader` from `int` to `float` due to backwards compatibility
-
-## 3.1.4
-
-- Fixed iteration searching for the primary device on `Asset` class
-
-## 3.1.3
-
-- Fixes on `Asset` entity validation, found by @simonjrojas!
-
-## 3.1.2
-
-- Set as optional the `asset_type` argument in `Asset` class
-
-## 3.1.1
-
-- Small fixes on some models to backwards compatibility
-
-## 3.1.0
-
-- Migrated all models to Pydantic
-- Removed models `Transaction`.
-- Added `mypy` to the project to enforce type checking
-- Migrated from `uniitest` to `pytest` to the project to enforce unit testing
-
-## 3.0.14
-
-- Fixes on `GET_CUSTOM_FIELD` LCL function, now accepts a default value as the second argument (Fallback as '')
-
-## 3.0.13
-
-- Added `LastMessage` entity to be used in `Trigger`s
-
-## 3.0.12
-
-- Moved `Geofence` model from `checkpoints` to `general`
-- Added `PresenceType` enum to be used in `Event` model
-
-## 3.0.11
-
-- Added way to standarize the `int` and `float` arguments to `float`. Allowing comparison between `int` and `float` values in LCL formulas
-
-## 3.0.10
-
-- Removed Self type annotation from all classes
-
-## 3.0.9
-
-- Added different return data of Report when password is set
-
-## 3.0.8
-
-- New linter and formatter using ruff
-- Added typings on all classes and functions available
-- New Report export format PDF (Not implemented yet)
-- Added new way to encrypt .xslx files directly using the `Report` class
-
-## 3.0.7
-
-- Added the value of `AssetOperationMode.ZONE`
-- Added a check for `Asset.operation_mode == ASSETMULTIPLE` while savind the list of child's
-- Clarified the deprecation of `ReportRow.height`
-
-## 3.0.6
-
-- Changed print in `LineChart` to a `log.warning` and `log.fatal` in case of error
-
-## 3.0.3
-
-- Implemented new chart rendering library `syncfusion_flutter_charts` for Flutter.
-- Changed rendering method for `LineChart`, now you should provide the `technology` to select the rendering library.
-
-## 3.0.2
-
-- Fixed issue with `IF()` LCL function, now only validates the nullability of the first argument.
-- Added new `VERSION()` LCL Function to get the current version of the package
-
-## 3.0.1
-
-- Added None validation on every LCL function, when any of the arguments is None, the function will return None
-- Added unit tests for all LCL functions
-
-## 3.0.0
-
-- Removed shared namespace to improve compatibility with other packages
-
-## 2.2.4
-
-- Defined new class `ReportConfiguration` to handle the configuration of the report in Python scripts
-
-## 2.2.3
-
-- Property `text_color` deprectated in `ReportCol`, replaced by a luminance-based color using the background color
-- Property `text_color` deprectated in `ReportHeader`, replaced by a luminance-based color using the background color
-- Property `width` deprectated in `ReportHeader`, replaced by the function `autofit()` to automatically fit the header width
-- New entity `CustomReportPage` that receives a custom builder function to build the page
-- Property `export_format` deprecated in `Report`, replaced to an argument of the function `export()`
-
-## 2.2.2
-
-- Updated `AssetOperationMode` to support `STATIC` and removal of `FAILOVER` mode
-
-## 2.2.1
-
-- Bug fixes related to removing __ from all classes
-
-## 2.2.0
-
-- Removed support to Python 3.12 due to a shared namespace issue.
-- Reorganized classes to better support.
-- Added typings to all classes and functions.
-
-## 2.1.5
-
-- Added declarative typing on all LCL functions
-- Added support for timezone in `UNIX_TO_STR` LCL function
-
-## 2.1.3
-
-- Changed build mode to pyproject.toml
-- Updated `LcLCore.perform()` function to receive additional globals and locals in their arguments
-
-## v2.1.2
-
-- Add UNIX_TO_STR LCL function
-
-## v2.1.1
-
-- Added `compact` in the json return format in reports
-
-## v2.1.0
-
-- Add bold format option to Col class
-- Add freeze header option to Page class
-
-## v2.0.1
-
-- Fixes on package namespace
-
-## v2.0.0
-
-- Deprecated `lcl.core` module
-- Changed `layrzsdk` to `layrz.sdk` package (With unified Layrz namespace)
-
-## v1.4.5
-
-- Added CaseIgnoredStatus to init file
-
-## v1.4.4
-
-- Added CaseIgnoredStatus to Case entity
-
-## v1.4.3
-
-- Added new ChartType: TableChart and NumberChart
-- Starting to replace documentation format from unstructured to a structured format
-
-## v1.4.2
-
-- Fix, added SUBSTRING LCL to global functions
-
-## v1.4.1
-
-- Fixed LineChart xAxis Datetime conversion for CanvasJS, now will multiply the timestamp by 1000 to use milliseconds
-
-## v1.4.0
-
-- Added support for Flutter `graphic` library
-  - LineChart
-  - AreaChart (Replaced previous AreaChart to a temporal extend of LineChart)
-  - BarChart
-  - ColumnChart
-  - PieChart
-  - MapChart
-  - ScatterChart
-  - RadialBarChart
-
-- Future deprecations:
-  - HTMLChart
-  - TimelineChart
-  - RadarChart
-
-## v1.3.9
-
-- Internal changes related to GitLab CI automation
-
-## v1.3.8
-
-- Added SUBSTRING LCL function
-
-## v.1.3.7
-
-- Added sequence in cases
-
-## v1.3.6
-
-- Added new Map Chart
-  - Added required entity MapPoint
-  - Added required enum MapCenterType
-- Added new HTML Chart
-
-## v1.3.5
-
-- Bug fix related to formula perform, added PRIMARY_DEVICE to simulation environment
-
-## v1.3.4
-
-- Added Transaction entity for REPCOM reports
-
-## v1.3.3
-
-- Added PRIMARY_DEVICE() function to Layrz Compute Language
-
-## v1.3.2
-
-- Updated styles of charts return object to ApexCharts or CanvasJS
-- Replaced all .rst files to .md files
-
-## v1.3.1
-
-- Removed markerSize (in CanvasJS) for dashed series
-
-## v1.3.0
-
-- Added support for CanvasJS Javascript Library
-- Deprecated to_apexcharts property in charts.
-- New method render() in charts with support for multiple Javascript rendering library
-- Added color helpers in layrzsdk.helpers
-
-## v1.2.6
-
-- Removed dataLabels in almost all charts (Except Pie and RadialBar)
-
-## v1.2.5
-
-- Optimizations for Javascript renderer
-
-## v1.2.4
-
-- Added dashed attribute to ChartDataSerie
-- Added the Possibility to mix charts, only available for:
-  - LineChart
-  - AreaChart
-  - ColumnChart
-  - ScatterChart (Only as serie, not as main chart)
-
-## v1.2.3
-
-- Added new value in BroadcastStatus
-
-## v1.2.2
-
-- Updated ReportCol entity to set new default values
-- New entity ReportDataType
-- Possibility to export directly to the Report class
-- Re-organized entities/ folder
-- Added Broadcasts entities
-
-## v1.2.1
-
-- Added Report Col entity
-
-## v1.2.0
-
-- Added reports entities
-
-## v1.1.4
-
-- Bug fixes
-
-## v1.1.3
-
-- Bug fixes
-
-## v1.1.2
-
-- Bug fixes
-
-## v1.1.1
-
-- Bug fixes
-
-## v1.1.0
-
-- Reorganized files
-- Added new Charts entities
-
-## v1.0.14
-
-- Added CONTAINS, STARTS_WITH, ENDS_WITH functions to the Layrz Computed Language
-
-## v1.0.13
-
-- Fixed missing import into `layrzsdk.entities.__init__.py`
-
-## v1.0.12
-
-- Added Geofence, Comment, Waypoint and Checkpoint entities
-
-## v1.0.11
-
-- Added User, Comment and Case entities
-
-## v1.0.10
-
-- Fixes
-
-## v1.0.9
-
-- Added Event and Trigger entities
-- Renamed file `mesage.py` to `message.py`
-
-## v1.0.8
-
-- Added title getter of all charts entities
-
-## v1.0.7
-
-- Added PieChart, BarChart, and RadialBarChart entities
-
-## v1.0.6
-
-- Fixed STING to STRING bug in ChartDataType enum
-
-## v1.0.5
-
-- Bug fixes
-
-## v1.0.4
-
-- Added data_type argument of ChartDataSerie
-
-## v1.0.3
-
-- Added Chart configuration entity
-
-## v1.0.2
-
-- Added entities for Range Charts:
-  - Line Charts
-  - Area Charts
-  - Column Charts
-
-## v1.0.1
-
-- Added entities for Sensors and Triggers
-
-## v1.0.0
-
-- Initial release