prism.py.client 1.0.0__tar.gz

prism_py_client-1.0.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: prism.py.client
+Version: 1.0.0
+Summary: Python client for prism.web.service
+Home-page: https://github.com/shangerxin/prism.client
+Author: Shang, Erxin
+Author-email: shangerxin@hotmail.com
+License: MIT
+Project-URL: Repository, https://github.com/shangerxin/prism.client
+Keywords: prism,prism.python.client,prism.py.client
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Prism Python Client
+
+Python helper for uploading benchmark and test artifacts to a Prism server.
+
+This README is intentionally focused on `prism_client.py` usage and examples.
+
+## Requirements
+
+- Python 3.10+
+
+## Install
+
+From this folder:
+
+```sh
+pip install -r requirements.txt
+```
+
+Optional editable install:
+
+```sh
+pip install -e .
+```
+
+## What `prism_client.py` Uploads
+
+The script can upload four metadata types:
+
+- `result`: test result payload to `POST /TestResult/AddResult/`
+- `env`: environment payload to `POST /TestResult/AddEnvirnoment/`
+- `param`: parameter payload to `POST /TestResult/AddParameter/`
+- `meta`: metadata payload to `POST /TestResult/AddMetadata/`
+
+`host` should include the API prefix, for example `https://localhost:44303/api/v1`.
+
+## CLI Usage
+
+```sh
+python prism_client.py host -t TEST_JOB -p PROJECT -m {env,meta,param,result} -n NAME (-j JSON | -c CSV) [options]
+```
+
+Required arguments:
+
+- `host`: Prism server API root URL
+- `-t, --test-job`: test job name
+- `-p, --project`: project name
+- `-m, --meta-type`: one of `env`, `meta`, `param`, `result`
+- `-n, --name`: unique label (`dataInfo`) for the uploaded payload
+- one of `-j, --json` or `-c, --csv`
+
+Optional arguments:
+
+- `-g, --build-guid`: build [GUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) (auto-generated if omitted)
+- `-s, --start`: start time ([ISO string](https://en.wikipedia.org/wiki/ISO_8601), defaults to current time)
+- `-e, --end`: end time ([ISO string](https://en.wikipedia.org/wiki/ISO_8601), defaults to current time)
+- `-x, --timeout-hours`: timeout in hours (default `0`)
+- `-b, --build-result`: one of `NotExecuted|Pass|Fail|Blocked|InProgress|Hang|Paused|Aborted`
+- `-r, --test-result`: one of `NotExecuted|Pass|Fail|Blocked|InProgress|Hang|Paused|Aborted`
+
+## Example: Upload Test Result From JSON
+
+Create `result.json`:
+
+```json
+{
+    "summary": {
+        "throughput": 1234,
+        "latency_ms": 21.4,
+        "passed": true
+    },
+    "details": [
+        {
+            "name": "case_001",
+            "status": "Pass",
+            "duration_ms": 120
+        }
+    ]
+}
+```
+
+Run:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m result \
+    -n benchmark-run-20260609 \
+    -j result.json \
+    -b Pass \
+    -r Pass
+```
+
+## Example: Upload Test Result From CSV
+
+If you provide CSV, the script converts it to JSON before upload.
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m result \
+    -n benchmark-run-csv \
+    -c result.csv \
+    -b Pass \
+    -r Pass
+```
+
+## Example: Upload Environment / Parameter / Metadata
+
+Environment:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m env \
+    -n hw-sw-info \
+    -j environment.json
+```
+
+Parameter:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m param \
+    -n runtime-args \
+    -j parameters.json
+```
+
+Metadata:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m meta \
+    -n build-info \
+    -j metadata.json
+```
+
+## Python API Example (Using `prism_client.py` Functions)
+
+```python
+import json
+import uuid
+from datetime import datetime, timezone
+
+from prism_client import upload_result
+
+host = "https://your-prism-server/api/v1"
+project = "YourProject"
+test_job = "YourTestJob"
+name = "benchmark-run-20260609"
+
+with open("result.json", "r", encoding="utf-8") as f:
+        payload = json.load(f)
+
+upload_result(
+        host=host,
+        project=project,
+        test_job=test_job,
+        name=name,
+        data=payload,
+        build_guid=str(uuid.uuid4()),
+        build_result="Pass",
+        test_result="Pass",
+        start=datetime.now(timezone.utc).isoformat(),
+        end=datetime.now(timezone.utc).isoformat(),
+        timeout_hours=0,
+)
+```
+
+## Run Tests
+
+```sh
+pytest
+```
+
+
+
+

prism_py_client-1.0.0/README.md

@@ -0,0 +1,184 @@
+# Prism Python Client
+
+Python helper for uploading benchmark and test artifacts to a Prism server.
+
+This README is intentionally focused on `prism_client.py` usage and examples.
+
+## Requirements
+
+- Python 3.10+
+
+## Install
+
+From this folder:
+
+```sh
+pip install -r requirements.txt
+```
+
+Optional editable install:
+
+```sh
+pip install -e .
+```
+
+## What `prism_client.py` Uploads
+
+The script can upload four metadata types:
+
+- `result`: test result payload to `POST /TestResult/AddResult/`
+- `env`: environment payload to `POST /TestResult/AddEnvirnoment/`
+- `param`: parameter payload to `POST /TestResult/AddParameter/`
+- `meta`: metadata payload to `POST /TestResult/AddMetadata/`
+
+`host` should include the API prefix, for example `https://localhost:44303/api/v1`.
+
+## CLI Usage
+
+```sh
+python prism_client.py host -t TEST_JOB -p PROJECT -m {env,meta,param,result} -n NAME (-j JSON | -c CSV) [options]
+```
+
+Required arguments:
+
+- `host`: Prism server API root URL
+- `-t, --test-job`: test job name
+- `-p, --project`: project name
+- `-m, --meta-type`: one of `env`, `meta`, `param`, `result`
+- `-n, --name`: unique label (`dataInfo`) for the uploaded payload
+- one of `-j, --json` or `-c, --csv`
+
+Optional arguments:
+
+- `-g, --build-guid`: build [GUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) (auto-generated if omitted)
+- `-s, --start`: start time ([ISO string](https://en.wikipedia.org/wiki/ISO_8601), defaults to current time)
+- `-e, --end`: end time ([ISO string](https://en.wikipedia.org/wiki/ISO_8601), defaults to current time)
+- `-x, --timeout-hours`: timeout in hours (default `0`)
+- `-b, --build-result`: one of `NotExecuted|Pass|Fail|Blocked|InProgress|Hang|Paused|Aborted`
+- `-r, --test-result`: one of `NotExecuted|Pass|Fail|Blocked|InProgress|Hang|Paused|Aborted`
+
+## Example: Upload Test Result From JSON
+
+Create `result.json`:
+
+```json
+{
+    "summary": {
+        "throughput": 1234,
+        "latency_ms": 21.4,
+        "passed": true
+    },
+    "details": [
+        {
+            "name": "case_001",
+            "status": "Pass",
+            "duration_ms": 120
+        }
+    ]
+}
+```
+
+Run:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m result \
+    -n benchmark-run-20260609 \
+    -j result.json \
+    -b Pass \
+    -r Pass
+```
+
+## Example: Upload Test Result From CSV
+
+If you provide CSV, the script converts it to JSON before upload.
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m result \
+    -n benchmark-run-csv \
+    -c result.csv \
+    -b Pass \
+    -r Pass
+```
+
+## Example: Upload Environment / Parameter / Metadata
+
+Environment:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m env \
+    -n hw-sw-info \
+    -j environment.json
+```
+
+Parameter:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m param \
+    -n runtime-args \
+    -j parameters.json
+```
+
+Metadata:
+
+```sh
+python prism_client.py https://your-prism-server/api/v1 \
+    -p YourProject \
+    -t YourTestJob \
+    -m meta \
+    -n build-info \
+    -j metadata.json
+```
+
+## Python API Example (Using `prism_client.py` Functions)
+
+```python
+import json
+import uuid
+from datetime import datetime, timezone
+
+from prism_client import upload_result
+
+host = "https://your-prism-server/api/v1"
+project = "YourProject"
+test_job = "YourTestJob"
+name = "benchmark-run-20260609"
+
+with open("result.json", "r", encoding="utf-8") as f:
+        payload = json.load(f)
+
+upload_result(
+        host=host,
+        project=project,
+        test_job=test_job,
+        name=name,
+        data=payload,
+        build_guid=str(uuid.uuid4()),
+        build_result="Pass",
+        test_result="Pass",
+        start=datetime.now(timezone.utc).isoformat(),
+        end=datetime.now(timezone.utc).isoformat(),
+        timeout_hours=0,
+)
+```
+
+## Run Tests
+
+```sh
+pytest
+```
+
+
+
+

prism_py_client-1.0.0/openapi_client/__init__.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    prism.web.service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "DashboardApi",
+    "ProjectApi",
+    "TestBuildApi",
+    "TestJobApi",
+    "TestResultApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "DeviceUnderTest",
+    "FuncStringTaskBoolean",
+    "Product",
+    "Project",
+    "Release",
+    "ResultType",
+    "Script",
+    "ScriptRepository",
+    "TestBuild",
+    "TestCase",
+    "TestJob",
+    "TestJobParameter",
+    "TestJobReportTemplate",
+    "TestMachine",
+    "TestPlan",
+    "TestPlanRecipe",
+    "TestReport",
+    "TestResult",
+    "TestSuite",
+    "UserCredential",
+]
+
+# import apis into sdk package
+from openapi_client.api.dashboard_api import DashboardApi as DashboardApi
+from openapi_client.api.project_api import ProjectApi as ProjectApi
+from openapi_client.api.test_build_api import TestBuildApi as TestBuildApi
+from openapi_client.api.test_job_api import TestJobApi as TestJobApi
+from openapi_client.api.test_result_api import TestResultApi as TestResultApi
+
+# import ApiClient
+from openapi_client.api_response import ApiResponse as ApiResponse
+from openapi_client.api_client import ApiClient as ApiClient
+from openapi_client.configuration import Configuration as Configuration
+from openapi_client.exceptions import OpenApiException as OpenApiException
+from openapi_client.exceptions import ApiTypeError as ApiTypeError
+from openapi_client.exceptions import ApiValueError as ApiValueError
+from openapi_client.exceptions import ApiKeyError as ApiKeyError
+from openapi_client.exceptions import ApiAttributeError as ApiAttributeError
+from openapi_client.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from openapi_client.models.device_under_test import DeviceUnderTest as DeviceUnderTest
+from openapi_client.models.func_string_task_boolean import FuncStringTaskBoolean as FuncStringTaskBoolean
+from openapi_client.models.product import Product as Product
+from openapi_client.models.project import Project as Project
+from openapi_client.models.release import Release as Release
+from openapi_client.models.result_type import ResultType as ResultType
+from openapi_client.models.script import Script as Script
+from openapi_client.models.script_repository import ScriptRepository as ScriptRepository
+from openapi_client.models.test_build import TestBuild as TestBuild
+from openapi_client.models.test_case import TestCase as TestCase
+from openapi_client.models.test_job import TestJob as TestJob
+from openapi_client.models.test_job_parameter import TestJobParameter as TestJobParameter
+from openapi_client.models.test_job_report_template import TestJobReportTemplate as TestJobReportTemplate
+from openapi_client.models.test_machine import TestMachine as TestMachine
+from openapi_client.models.test_plan import TestPlan as TestPlan
+from openapi_client.models.test_plan_recipe import TestPlanRecipe as TestPlanRecipe
+from openapi_client.models.test_report import TestReport as TestReport
+from openapi_client.models.test_result import TestResult as TestResult
+from openapi_client.models.test_suite import TestSuite as TestSuite
+from openapi_client.models.user_credential import UserCredential as UserCredential
+

prism_py_client-1.0.0/openapi_client/api/__init__.py

@@ -0,0 +1,9 @@
+# flake8: noqa
+
+# import apis into api package
+from openapi_client.api.dashboard_api import DashboardApi
+from openapi_client.api.project_api import ProjectApi
+from openapi_client.api.test_build_api import TestBuildApi
+from openapi_client.api.test_job_api import TestJobApi
+from openapi_client.api.test_result_api import TestResultApi
+