Merge branch 'dev' into feature/toml-config

Author: kzscisoft

.github/workflows/test_client_macos.yml

@@ -11,14 +11,14 @@ permissions:
 
 jobs:
   build:
-    timeout-minutes: 10
+    timeout-minutes: 20
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python 3.11
+    - name: Set up Python 3.12
       uses: actions/setup-python@v3
       with:
-        python-version: "3.11"
+        python-version: "3.12"
     - name: Install dependencies
       run: |
         rm poetry.lock

.github/workflows/test_client_ubuntu.yml

@@ -16,13 +16,13 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 20
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python 3.11
+    - name: Set up Python 3.12
       uses: actions/setup-python@v3
       with:
-        python-version: "3.11"
+        python-version: "3.12"
     - name: Install dependencies
       run: python -m pip install poetry
     - name: Test with pytest

.github/workflows/test_client_windows.yml

@@ -12,13 +12,13 @@ permissions:
 jobs:
   build:
     runs-on: windows-latest
-    timeout-minutes: 10
+    timeout-minutes: 20
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python 3.11
+    - name: Set up Python 3.12
       uses: actions/setup-python@v3
       with:
-        python-version: "3.11"
+        python-version: "3.12"
     - name: Install dependencies
       run: |
         rm poetry.lock

.github/workflows/test_multiple_python.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Simvue Client (Python Versions)
+
+on:
+  push:
+    branches: [ "main", "dev", "hotfix/update-ci" ]
+  pull_request:
+    branches: [ "main", "dev", "hotfix/update-ci" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+        matrix:
+            python-version: ['3.9', '3.10', '3.11']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: "${{ matrix.python-version }}"
+    - name: Install dependencies
+      run: python -m pip install poetry
+    - name: Test with pytest
+      run: |
+        export SIMVUE_URL=${{ secrets.SIMVUE_URL }}
+        export SIMVUE_TOKEN=${{ secrets.SIMVUE_TOKEN }}
+        poetry install --all-extras
+        poetry run pytest --cov --cov-report=xml tests/unit/ tests/refactor/

.gitignore

@@ -135,6 +135,7 @@ dmypy.json
 # Simvue files
 simvue.ini
 simvue.toml
+offline/
 
 # Pyenv
 .python-version

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
         args: [--branch, main, --branch, dev]
       - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.2
+    rev: v0.4.4
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, "--ignore=C901" ]

README.md

@@ -12,6 +12,7 @@ Collect metadata, metrics and artifacts from simulations, processing and AI/ML t
 
 <div align="center">
 <a href="https://github.com/simvue-io/client/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/simvue-io/client"/></a>
+<img src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue">
 <a href="https://pypi.org/project/simvue/" target="_blank"><img src="https://img.shields.io/pypi/v/simvue.svg"/></a>
 <a href="https://pepy.tech/project/simvue"><img src="https://static.pepy.tech/badge/simvue"/></a>
 <p></p>

poetry.lock

@@ -5,6 +5,30 @@ description = "Simulation tracking and monitoring"
 authors = ["Simvue Development Team <[email protected]>"]
 license = "Apache v2"
 readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: Unix",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: System :: Monitoring",
+    "Topic :: Utilities",
+    "Typing :: Typed"
+]
+
+keywords = [
+    "tracking",
+    "monitoring",
+    "metrics",
+    "alerting",
+    "metrics-gathering"
+]
 
 [tool.poetry.dependencies]
 python = "^3.9"
@@ -19,8 +43,11 @@ pandas = {version = "^2.2.0", optional = true}
 plotly = {version = "^5.18.0", optional = true}
 numpy = {version = "^1.26.3", optional = true}
 matplotlib = {version = "^3.8.2", optional = true}
+typing_extensions = { version = "^4.11.0", python = "<3.10" }
 toml = "^0.10.2"
 click = "^8.1.7"
+humanfriendly = "^10.0"
+tabulate = "^0.9.0"
 
 [tool.poetry.extras]
 dataset = ["pandas", "numpy"]

pyproject.toml

@@ -258,10 +258,12 @@ def get_runs(
         alerts: bool = False,
         metadata: bool = False,
         format: typing.Literal["dict", "dataframe"] = "dict",
+        count: int = 100,
+        start_index: int = 0,
     ) -> typing.Union[
         "DataFrame", list[dict[str, typing.Union[int, str, float, None]]], None
     ]:
-        """Retrieve all runs matching filters
+        """Retrieve all runs matching filters.
 
         Parameters
         ----------
@@ -280,6 +282,10 @@ def get_runs(
         format : str ('dict' | 'dataframe'), optional
             the structure of the response, either a dictionary or a dataframe.
             Default is 'dict'. Pandas must be installed for 'dataframe'.
+        count : int, optional
+            maximum number of entries to return. Default is 100.
+        start_index : int, optional
+            the index from which to count entries. Default is 0.
 
         Returns
         -------
@@ -301,6 +307,8 @@ def get_runs(
             "return_alerts": alerts,
             "return_system": system,
             "return_metadata": metadata,
+            "count": count,
+            "start": start_index,
         }
 
         response = requests.get(
@@ -778,14 +786,21 @@ def get_folder(self, folder_id: str) -> typing.Optional[dict[str, typing.Any]]:
         return _folders[0]
 
     def get_folders(
-        self, filters: typing.Optional[list[str]] = None
+        self,
+        filters: typing.Optional[list[str]] = None,
+        count: int = 100,
+        start_index: int = 0,
     ) -> list[dict[str, typing.Any]]:
         """Retrieve folders from the server
 
         Parameters
         ----------
         filters : list[str] | None
             set of filters to apply to the search
+        count : int, optional
+            maximum number of entries to return. Default is 100.
+        start_index : int, optional
+            the index from which to count entries. Default is 0.
 
         Returns
         -------
@@ -797,7 +812,11 @@ def get_folders(
         RuntimeError
             if there was a failure retrieving data from the server
         """
-        params: dict[str, str] = {"filters": json.dumps(filters or [])}
+        params: dict[str, typing.Union[str, int]] = {
+            "filters": json.dumps(filters or []),
+            "count": count,
+            "start": start_index,
+        }
 
         response: requests.Response = requests.get(
             f"{self._url}/api/folders", headers=self._headers, params=params
@@ -873,7 +892,7 @@ def _get_run_metrics_from_server(
             "xaxis": xaxis,
             "max_points": max_points,
         }
-        print(params)
+
         metrics_response: requests.Response = requests.get(
             f"{self._url}/api/metrics", headers=self._headers, params=params
         )
@@ -1105,7 +1124,7 @@ def get_events(
         """
 
         msg_filter: str = (
-            json.dumps([{"operator": "contains", "value": message_contains}])
+            json.dumps([f"event.message contains {message_contains}"])
             if message_contains
             else ""
         )