layrz-sdk 3.1.12__tar.gz → 3.1.14__tar.gz

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14}/.github/workflows/deploy.yml

@@ -24,14 +24,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       
-      - name: Build
+      - name: Build and upload
         run: |
           uv venv --python 3.13
           uv sync --only-group dev
           uv run python -m build
-        
-      - name: Upload to Python Package Index
-        uses: pypa/gh-action-pypi-publish@v1.8.10
-        with:
-          user: ${{ secrets.LAYRZ_PYPI_USERNAME }}
-          password: ${{ secrets.LAYRZ_PYPI_PASSWORD }}
+          uv run python -m twine upload -u ${{ secrets.LAYRZ_PYPI_USERNAME }} -p ${{ secrets.LAYRZ_PYPI_PASSWORD }} dist/*

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14}/.vscode/settings.json

@@ -18,5 +18,14 @@
   ],
   "mypy-type-checker.importStrategy": "fromEnvironment",
   "python.testing.unittestEnabled": false,
-  "python.testing.pytestEnabled": true
+  "python.testing.pytestEnabled": true,
+  "cSpell.words": [
+    "Aptos",
+    "autofit",
+    "layrz",
+    "msoffice",
+    "rtype",
+    "xlswriter",
+    "xslx"
+  ]
 }

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.14
+
+- Some changes related to the `Case` entity
+
 ## 3.1.12
 
 - Adjustment of all typings

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14}/CODE_OF_CONDUCT.md

@@ -1,18 +1,23 @@
 # Code of conduct
 
 ## Be friendly and patient.
+
 Our objective is contribute to community and help us together to create better code.
 
 ## Be welcoming
+
 We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
 
 ## Be considerate
+
 Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
 
 ## Be respectful
+
 Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one.
 
 ## Be careful in the words that you choose
+
 We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
   * Violent threats or language directed against another person.
   * Discriminatory jokes and language.

layrz_sdk-3.1.14/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+As an open source project, we welcomes contributions of many forms.
+
+## To request a Pull Request
+
+Please follow the next structure of your request:
+
+1. **Title**: A short description of the change.
+
+2. **Description**: A detailed description of the change, including:
+  - What is the problem you are solving?
+  - How does your change solve the problem?
+  - Any additional information that might be helpful for reviewers.
+
+3. **Code**: The code changes you are proposing, including:
+  - The files you are changing.
+  - The specific lines of code that are being added, modified, or removed.
+  - Any tests you have written to verify your changes.
+
+4. **Testing**: A description of how you tested your changes, including:
+  - The environment you tested in (e.g., local, staging).
+  - Any specific test cases you ran.
+  - The results of your tests.
+
+You can attach screenshots or other files to help illustrate your changes.

{layrz_sdk-3.1.12/layrz_sdk.egg-info → layrz_sdk-3.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.12
+Version: 3.1.14
 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.12 → layrz_sdk-3.1.14}/layrz_sdk/entities/case.py

@@ -41,7 +41,11 @@ class Case(BaseModel):
     """Validate model"""
     sequence = data.get('sequence')
     if sequence is not None and isinstance(sequence, int):
-      data['sequence'] = f'{data["trigger"].code}/{sequence}'
+      trigger = data['trigger']
+      if not isinstance(trigger, Trigger):
+        data['sequence'] = f'{trigger["code"]}/{data["pk"]}'
+      else:
+        data['sequence'] = f'{trigger.code}/{sequence}'
     else:
       data['sequence'] = f'GENERIC/{data["pk"]}'
 

layrz_sdk-3.1.14/layrz_sdk/entities/custom_report_page.py

@@ -0,0 +1,40 @@
+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-3.1.12 → layrz_sdk-3.1.14}/layrz_sdk/entities/report.py

@@ -190,7 +190,13 @@ class Report(BaseModel):
       sheet = book.add_worksheet(sheet_name)
 
       if isinstance(page, CustomReportPage):
-        page.builder(sheet)
+        if page.extended_builder:
+          page.extended_builder(sheet=sheet, workbook=book)
+        elif page.builder:
+          page.builder(sheet)
+        else:
+          raise AttributeError('Custom report page must have a builder or extended_builder function')
+
         sheet.autofit()
         continue
 

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.12
+Version: 3.1.14
 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.12 → layrz_sdk-3.1.14}/pyproject.toml

@@ -1,104 +1,104 @@
-[project]
-name = "layrz-sdk"
-version = "3.1.12"
-description = "Layrz SDK for Python"
-authors = [
-  {name = "Golden M, Inc.", email = "software@goldenm.com"}
-]
-requires-python = ">=3.10, <3.14"
-
-maintainers = [
-  {name = "Kenny Mochizuki", email = "kenny@goldenm.com"},
-  {name = "Luis Reyes", email = "lreyes@goldenm.com"},
-  {name = "Kasen Li", email = "kli@goldenm.com"},
-]
-
-readme = "README.md"
-
-license = {text = "MIT License"}
-
-keywords = [
-  "sdk",
-  "goldenm",
-  "lcl",
-  "layrz compute language",
-  "layrz",
-]
-classifiers = [
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-]
-dependencies = [
-  "requests",
-  "xlsxwriter",
-  "tzdata",
-  "pydantic>=2.10.6",
-  "typing-extensions>=4.10.0",
-]
-
-[project.urls]
-Repository = "https://github.com/goldenm-software/layrz-sdk"
-Changelog = "https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md"
-
-[build-system]
-requires = ["setuptools", "setuptools-scm"]
-build-backend = "setuptools.build_meta"
-
-[dependency-groups]
-dev = [
-    "build>=1.2.2.post1",
-    "mypy>=1.15.0",
-    "pytest>=8.3.5",
-    "python-dotenv>=1.0.1",
-    "ruff>=0.11.0",
-    "twine>=6.1.0",
-]
-
-
-[tool.ruff]
-indent-width = 2
-line-length = 120
-
-exclude = [".venv"]
-
-[tool.ruff.lint]
-ignore = [
-  "F401", # Unused import
-  "E701", # Multiple statements on one line
-  "TD003", # Missing issue link
-  "ANN401", # Any type annotation
-]
-
-select = [
-  "I", # isort
-  "E", "W", # pycodestyle
-  "F", # pyflakes
-  "B", # flakes8-bugbear
-  "TD", # flake8-todo
-  "DJ", # flake8-django
-  "DTZ", # flake8-datetimez
-  "T20", # flake8-print # En un futuro
-  "PYI", # flake8-pyi
-  "ANN", # flake8-annotations
-]
-
-[tool.ruff.format]
-quote-style = "single"
-indent-style = "space"
-docstring-code-format = true
-
-[tool.mypy]
-python_version = "3.10"
-strict = true
-ignore_missing_imports = true
-check_untyped_defs = true
-disallow_untyped_defs = true
-
-exclude = [
-  ".*\\.venv",
-  ".*\\.ruff_cache",
-  ".*\\.mypy_cache",
-]
+[project]
+name = "layrz-sdk"
+version = "3.1.14"
+description = "Layrz SDK for Python"
+authors = [
+  {name = "Golden M, Inc.", email = "software@goldenm.com"}
+]
+requires-python = ">=3.10, <3.14"
+
+maintainers = [
+  {name = "Kenny Mochizuki", email = "kenny@goldenm.com"},
+  {name = "Luis Reyes", email = "lreyes@goldenm.com"},
+  {name = "Kasen Li", email = "kli@goldenm.com"},
+]
+
+readme = "README.md"
+
+license = {text = "MIT License"}
+
+keywords = [
+  "sdk",
+  "goldenm",
+  "lcl",
+  "layrz compute language",
+  "layrz",
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+  "requests",
+  "xlsxwriter",
+  "tzdata",
+  "pydantic>=2.10.6",
+  "typing-extensions>=4.10.0",
+]
+
+[project.urls]
+Repository = "https://github.com/goldenm-software/layrz-sdk"
+Changelog = "https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "build>=1.2.2.post1",
+    "mypy>=1.15.0",
+    "pytest>=8.3.5",
+    "python-dotenv>=1.0.1",
+    "ruff>=0.11.0",
+    "twine>=6.1.0",
+]
+
+
+[tool.ruff]
+indent-width = 2
+line-length = 120
+
+exclude = [".venv"]
+
+[tool.ruff.lint]
+ignore = [
+  "F401", # Unused import
+  "E701", # Multiple statements on one line
+  "TD003", # Missing issue link
+  "ANN401", # Any type annotation
+]
+
+select = [
+  "I", # isort
+  "E", "W", # pycodestyle
+  "F", # pyflakes
+  "B", # flakes8-bugbear
+  "TD", # flake8-todo
+  "DJ", # flake8-django
+  "DTZ", # flake8-datetimez
+  "T20", # flake8-print # En un futuro
+  "PYI", # flake8-pyi
+  "ANN", # flake8-annotations
+]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+docstring-code-format = true
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+ignore_missing_imports = true
+check_untyped_defs = true
+disallow_untyped_defs = true
+
+exclude = [
+  ".*\\.venv",
+  ".*\\.ruff_cache",
+  ".*\\.mypy_cache",
+]

{layrz_sdk-3.1.12 → layrz_sdk-3.1.14}/uv.lock

@@ -318,7 +318,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "3.1.12"
+version = "3.1.14"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },

layrz_sdk-3.1.12/CONTRIBUTING.md

@@ -1,30 +0,0 @@
-# Contributing
-
-As an open source project, we welcomes contributions of many forms.
-
-## To request a Merge Request
-
-Please follow the next structure of your request:
-
-### Title
-
-A short description of your feature/fix
-
-Also, add this prefix in the title according to the scenario:
-
-| Prefix/Tag | Meaning |
-|-|-|
-| `feature/` | New feature, like new methods, classes, etc. |
-| `fix/` | Bug fix or documentation related fix |
-| `docs/` | Documentation related changes |
-
-### Description
-
-Explain your feature/fix request and why we should be approve.
-
-Be explicit and precise with your submission, that helps us to review and approve your request.
-
-## Code of Conduct
-
-As a contributor, you can help us keep the Layrz community open and inclusive.
-Please read and follow our code of conduct in `CODE_OF_CONDUCT.md`.

layrz_sdk-3.1.12/layrz_sdk/entities/custom_report_page.py

@@ -1,16 +0,0 @@
-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',
-  )