tofupilot 2.2.2__tar.gz → 2.2.3__tar.gz

tofupilot-2.2.3/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: tofupilot
+Version: 2.2.3
+Summary: Official Python client for TofuPilot with OpenHTF integration, real-time streaming and file attachment support
+License: MIT
+License-File: LICENSE
+Keywords: automatic,hardware,testing,tofupilot,openhtf,sdk
+Author: TofuPilot Team
+Author-email: hello@tofupilot.com
+Requires-Python: >=3.9.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: dev
+Requires-Dist: build ; extra == "dev"
+Requires-Dist: certifi (>=2023.7.22)
+Requires-Dist: httpcore (>=1.0.9)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: mypy (==1.15.0) ; extra == "dev"
+Requires-Dist: openhtf
+Requires-Dist: packaging (>=20.0)
+Requires-Dist: paho-mqtt (>=2.0.0)
+Requires-Dist: posthog (>=3.0.0)
+Requires-Dist: pydantic (>=2.11.2)
+Requires-Dist: pylint (==3.2.3) ; extra == "dev"
+Requires-Dist: pytest (>=6.0.0)
+Requires-Dist: python-dotenv ; extra == "dev"
+Requires-Dist: requests (>=2.25.0)
+Requires-Dist: trycast ; extra == "dev"
+Requires-Dist: twine ; extra == "dev"
+Project-URL: Documentation, https://tofupilot.com/docs
+Project-URL: Homepage, https://github.com/tofupilot/python-client
+Project-URL: Issues, https://github.com/tofupilot/python-client/issues
+Project-URL: Repository, https://github.com/tofupilot/python-client
+Description-Content-Type: text/markdown
+
+# TofuPilot Python Client
+
+[![PyPI version](https://badge.fury.io/py/tofupilot.svg)](https://badge.fury.io/py/tofupilot)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/upview/8e092a304bae7d91aa154e19bdf694a4/raw/python-client-tests.json)](https://github.com/tofupilot/python)
+
+The official Python client for [TofuPilot](https://tofupilot.com). Integrate your hardware test runs into one app with just a few lines of Python.
+
+## Installation
+
+```bash
+pip install tofupilot
+```
+
+## Quick Start
+
+```python
+import os
+from tofupilot.v2 import TofuPilot
+
+with TofuPilot(api_key=os.getenv("TOFUPILOT_API_KEY")) as client:
+    run = client.runs.create(
+        procedure_id="your-procedure-id",
+        serial_number="SN001",
+        part_number="PN001",
+        outcome="PASS",
+    )
+    print(f"Run created: {run.id}")
+```
+
+## Authentication
+
+Set your API key as an environment variable:
+
+```bash
+export TOFUPILOT_API_KEY="your-api-key"
+```
+
+Or pass it directly:
+
+```python
+client = TofuPilot(api_key="your-api-key")
+```
+
+To point to a different server (e.g. self-hosted):
+
+```python
+client = TofuPilot(api_key="your-api-key", server_url="https://your-instance.com/api")
+```
+
+## Available Resources
+
+| Resource | Operations |
+|----------|-----------|
+| `client.runs` | list, create, get, delete, update |
+| `client.units` | list, create, get, delete, update, add_child, remove_child |
+| `client.parts` | list, create, get, delete, update |
+| `client.parts.revisions` | create, get, delete, update |
+| `client.procedures` | list, create, get, delete, update |
+| `client.procedures.versions` | create, get, delete |
+| `client.batches` | list, create, get, delete, update |
+| `client.stations` | list, create, get, get_current, remove, update |
+| `client.attachments` | initialize, finalize, delete, upload, download |
+| `client.user` | list |
+
+## Usage Examples
+
+### Create a run with measurements
+
+```python
+from datetime import datetime, timedelta, timezone
+
+run = client.runs.create(
+    procedure_id=procedure_id,
+    serial_number="SN-001",
+    part_number="PCB-V1",
+    outcome="PASS",
+    started_at=datetime.now(timezone.utc) - timedelta(minutes=5),
+    ended_at=datetime.now(timezone.utc),
+    phases=[{
+        "name": "Voltage Test",
+        "outcome": "PASS",
+        "started_at": datetime.now(timezone.utc) - timedelta(minutes=5),
+        "ended_at": datetime.now(timezone.utc),
+        "measurements": [{
+            "name": "Output Voltage",
+            "outcome": "PASS",
+            "measured_value": 3.3,
+            "units": "V",
+            "validators": [
+                {"operator": ">=", "expected_value": 3.0},
+                {"operator": "<=", "expected_value": 3.6},
+            ],
+        }],
+    }],
+)
+```
+
+### List and filter runs
+
+```python
+result = client.runs.list(
+    part_numbers=["PCB-V1"],
+    outcomes=["PASS"],
+    limit=10,
+)
+
+for run in result.data:
+    print(f"{run.id} — {run.unit.serial_number}")
+```
+
+### Manage units and sub-units
+
+```python
+# Create part and revision
+client.parts.create(number="PCB-V1", name="Main Board")
+client.parts.revisions.create(part_number="PCB-V1", number="REV-A")
+
+# Create units
+client.units.create(serial_number="PARENT-001", part_number="PCB-V1", revision_number="REV-A")
+client.units.create(serial_number="CHILD-001", part_number="PCB-V1", revision_number="REV-A")
+
+# Link parent-child
+client.units.add_child(serial_number="PARENT-001", child_serial_number="CHILD-001")
+```
+
+### Upload and download attachments
+
+```python
+# Upload a file (one line)
+attachment_id = client.attachments.upload("report.pdf")
+
+# Link to a run
+client.runs.update(id=run_id, attachments=[attachment_id])
+
+# Download an attachment
+client.attachments.download(attachment, dest="local-copy.pdf")
+```
+
+## Error Handling
+
+```python
+from tofupilot.v2.models.errors import ErrorNOTFOUND, ErrorBADREQUEST
+
+try:
+    client.runs.get(id="nonexistent-id")
+except ErrorNOTFOUND as e:
+    print(f"Not found: {e.message}")
+except ErrorBADREQUEST as e:
+    print(f"Bad request: {e.message}")
+```
+
+| Exception | Status Code |
+|-----------|------------|
+| `ErrorBADREQUEST` | 400 |
+| `ErrorUNAUTHORIZED` | 401 |
+| `ErrorFORBIDDEN` | 403 |
+| `ErrorNOTFOUND` | 404 |
+| `ErrorCONFLICT` | 409 |
+| `ErrorUNPROCESSABLECONTENT` | 422 |
+| `ErrorINTERNALSERVERERROR` | 500 |
+
+## Running Tests
+
+```bash
+cd clients/python-speakeasy
+cp tests/.env.local.example tests/.env.local  # Set your API key and URL
+python -m pytest tests/v2/
+```
+
+## Documentation
+
+- [Getting Started](https://tofupilot.com/docs/dashboard)
+- [API Reference](https://tofupilot.com/docs/dashboard/api/v2)
+- [Changelog](https://tofupilot.com/changelog)
+
+## License
+
+MIT
+

tofupilot-2.2.3/README.md

@@ -0,0 +1,179 @@
+# TofuPilot Python Client
+
+[![PyPI version](https://badge.fury.io/py/tofupilot.svg)](https://badge.fury.io/py/tofupilot)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/upview/8e092a304bae7d91aa154e19bdf694a4/raw/python-client-tests.json)](https://github.com/tofupilot/python)
+
+The official Python client for [TofuPilot](https://tofupilot.com). Integrate your hardware test runs into one app with just a few lines of Python.
+
+## Installation
+
+```bash
+pip install tofupilot
+```
+
+## Quick Start
+
+```python
+import os
+from tofupilot.v2 import TofuPilot
+
+with TofuPilot(api_key=os.getenv("TOFUPILOT_API_KEY")) as client:
+    run = client.runs.create(
+        procedure_id="your-procedure-id",
+        serial_number="SN001",
+        part_number="PN001",
+        outcome="PASS",
+    )
+    print(f"Run created: {run.id}")
+```
+
+## Authentication
+
+Set your API key as an environment variable:
+
+```bash
+export TOFUPILOT_API_KEY="your-api-key"
+```
+
+Or pass it directly:
+
+```python
+client = TofuPilot(api_key="your-api-key")
+```
+
+To point to a different server (e.g. self-hosted):
+
+```python
+client = TofuPilot(api_key="your-api-key", server_url="https://your-instance.com/api")
+```
+
+## Available Resources
+
+| Resource | Operations |
+|----------|-----------|
+| `client.runs` | list, create, get, delete, update |
+| `client.units` | list, create, get, delete, update, add_child, remove_child |
+| `client.parts` | list, create, get, delete, update |
+| `client.parts.revisions` | create, get, delete, update |
+| `client.procedures` | list, create, get, delete, update |
+| `client.procedures.versions` | create, get, delete |
+| `client.batches` | list, create, get, delete, update |
+| `client.stations` | list, create, get, get_current, remove, update |
+| `client.attachments` | initialize, finalize, delete, upload, download |
+| `client.user` | list |
+
+## Usage Examples
+
+### Create a run with measurements
+
+```python
+from datetime import datetime, timedelta, timezone
+
+run = client.runs.create(
+    procedure_id=procedure_id,
+    serial_number="SN-001",
+    part_number="PCB-V1",
+    outcome="PASS",
+    started_at=datetime.now(timezone.utc) - timedelta(minutes=5),
+    ended_at=datetime.now(timezone.utc),
+    phases=[{
+        "name": "Voltage Test",
+        "outcome": "PASS",
+        "started_at": datetime.now(timezone.utc) - timedelta(minutes=5),
+        "ended_at": datetime.now(timezone.utc),
+        "measurements": [{
+            "name": "Output Voltage",
+            "outcome": "PASS",
+            "measured_value": 3.3,
+            "units": "V",
+            "validators": [
+                {"operator": ">=", "expected_value": 3.0},
+                {"operator": "<=", "expected_value": 3.6},
+            ],
+        }],
+    }],
+)
+```
+
+### List and filter runs
+
+```python
+result = client.runs.list(
+    part_numbers=["PCB-V1"],
+    outcomes=["PASS"],
+    limit=10,
+)
+
+for run in result.data:
+    print(f"{run.id} — {run.unit.serial_number}")
+```
+
+### Manage units and sub-units
+
+```python
+# Create part and revision
+client.parts.create(number="PCB-V1", name="Main Board")
+client.parts.revisions.create(part_number="PCB-V1", number="REV-A")
+
+# Create units
+client.units.create(serial_number="PARENT-001", part_number="PCB-V1", revision_number="REV-A")
+client.units.create(serial_number="CHILD-001", part_number="PCB-V1", revision_number="REV-A")
+
+# Link parent-child
+client.units.add_child(serial_number="PARENT-001", child_serial_number="CHILD-001")
+```
+
+### Upload and download attachments
+
+```python
+# Upload a file (one line)
+attachment_id = client.attachments.upload("report.pdf")
+
+# Link to a run
+client.runs.update(id=run_id, attachments=[attachment_id])
+
+# Download an attachment
+client.attachments.download(attachment, dest="local-copy.pdf")
+```
+
+## Error Handling
+
+```python
+from tofupilot.v2.models.errors import ErrorNOTFOUND, ErrorBADREQUEST
+
+try:
+    client.runs.get(id="nonexistent-id")
+except ErrorNOTFOUND as e:
+    print(f"Not found: {e.message}")
+except ErrorBADREQUEST as e:
+    print(f"Bad request: {e.message}")
+```
+
+| Exception | Status Code |
+|-----------|------------|
+| `ErrorBADREQUEST` | 400 |
+| `ErrorUNAUTHORIZED` | 401 |
+| `ErrorFORBIDDEN` | 403 |
+| `ErrorNOTFOUND` | 404 |
+| `ErrorCONFLICT` | 409 |
+| `ErrorUNPROCESSABLECONTENT` | 422 |
+| `ErrorINTERNALSERVERERROR` | 500 |
+
+## Running Tests
+
+```bash
+cd clients/python-speakeasy
+cp tests/.env.local.example tests/.env.local  # Set your API key and URL
+python -m pytest tests/v2/
+```
+
+## Documentation
+
+- [Getting Started](https://tofupilot.com/docs/dashboard)
+- [API Reference](https://tofupilot.com/docs/dashboard/api/v2)
+- [Changelog](https://tofupilot.com/changelog)
+
+## License
+
+MIT

{tofupilot-2.2.2 → tofupilot-2.2.3}/pyproject.toml

@@ -1,10 +1,9 @@
 [project]
 name = "tofupilot"
-version = "2.2.2"
+version = "2.2.3"
 description = "Official Python client for TofuPilot with OpenHTF integration, real-time streaming and file attachment support"
 authors = [
     { name = "TofuPilot Team", email = "hello@tofupilot.com" },
-    { name = "Speakeasy" }
 ]
 readme = "README.md"
 license = { text = "MIT" }

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/__init__.py

@@ -2,7 +2,7 @@
 
 This package provides both v1 and v2 API clients:
 - v1: Legacy client for backward compatibility
-- v2: New Speakeasy-generated SDK with enhanced features and error tracking
+- v2: Current SDK with enhanced features and error tracking
 
 For new projects, we recommend using the v2 client.
 

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v1/utils/files.py

@@ -96,6 +96,9 @@ def upload_file(
         upload_url = response_json.get("uploadUrl")
         upload_id = response_json.get("id")
 
+        if not upload_id or not upload_url:
+            raise ValueError(f"Upload initialization failed: missing 'id' or 'uploadUrl' in response: {response_json}")
+
         # File storing
         with open(file_path, "rb") as file:
             content_type, _ = mimetypes.guess_type(file_path) or "application/octet-stream"

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v2/__init__.py

@@ -1,4 +1,8 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# Import the error tracking enhanced client by default
+from .client_with_error_tracking import TofuPilotWithErrorTracking as TofuPilot
+# Still export the base SDK for those who want it
+from .sdk import TofuPilot as TofuPilotBase
+from .sdkconfiguration import *
 
 from ._version import (
     __title__,
@@ -7,25 +11,17 @@ from ._version import (
     __gen_version__,
     __user_agent__,
 )
-# Import the error tracking enhanced client by default
-from .client_with_error_tracking import TofuPilotWithErrorTracking as TofuPilot
-# Still export the base SDK for those who want it
-from .sdk import TofuPilot as TofuPilotBase
-from .sdkconfiguration import *
-
 
 VERSION: str = __version__
 OPENAPI_DOC_VERSION = __openapi_doc_version__
-SPEAKEASY_GENERATOR_VERSION = __gen_version__
+GENERATOR_VERSION = __gen_version__
 USER_AGENT = __user_agent__
 
-# Export both versions
 __all__ = [
-    "TofuPilot",  # Default with error tracking
-    "TofuPilotBase",  # Base without error tracking
-    # Version info
+    "TofuPilot",
+    "TofuPilotBase",
     "VERSION",
     "OPENAPI_DOC_VERSION",
-    "SPEAKEASY_GENERATOR_VERSION",
+    "GENERATOR_VERSION",
     "USER_AGENT",
 ]

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v2/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "tofupilot.v2"
-__version__: str = "0.7.12"
+__version__: str = "2.2.3"
 __openapi_doc_version__: str = "2.0.0"
 __gen_version__: str = "2.657.1"
-__user_agent__: str = "speakeasy-sdk/python 0.7.12 2.657.1 2.0.0 tofupilot.v2"
+__user_agent__: str = "speakeasy-sdk/python 2.2.3 2.657.1 2.0.0 tofupilot.v2"
 
 try:
     if __package__ is not None:

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v2/attachments.py

@@ -251,7 +251,7 @@ class Attachments(BaseSDK):
     ) -> models.AttachmentDeleteResponse:
         r"""Delete attachments
 
-        Permanently delete attachments by their IDs and unlink them from any associated runs or units.
+        Permanently delete attachments by their IDs and unlink them from any associated runs or units. Removes files from storage and clears all references.
 
         :param ids: Upload IDs to delete
         :param retries: Override the default retry configuration for this method
@@ -353,7 +353,7 @@ class Attachments(BaseSDK):
     ) -> models.AttachmentDeleteResponse:
         r"""Delete attachments
 
-        Permanently delete attachments by their IDs and unlink them from any associated runs or units.
+        Permanently delete attachments by their IDs and unlink them from any associated runs or units. Removes files from storage and clears all references.
 
         :param ids: Upload IDs to delete
         :param retries: Override the default retry configuration for this method
@@ -455,7 +455,7 @@ class Attachments(BaseSDK):
     ) -> models.AttachmentFinalizeResponse:
         r"""Finalize upload
 
-        Finalize a file upload after uploading to the pre-signed URL. Validates the file and records its metadata. Link the attachment to a run or unit using Update Run or Update Unit.
+        Finalize a file upload after uploading to the pre-signed URL. Validates the file and records its metadata.
 
         :param id: ID of the upload to finalize
         :param retries: Override the default retry configuration for this method
@@ -552,7 +552,7 @@ class Attachments(BaseSDK):
     ) -> models.AttachmentFinalizeResponse:
         r"""Finalize upload
 
-        Finalize a file upload after uploading to the pre-signed URL. Validates the file and records its metadata. Link the attachment to a run or unit using Update Run or Update Unit.
+        Finalize a file upload after uploading to the pre-signed URL. Validates the file and records its metadata.
 
         :param id: ID of the upload to finalize
         :param retries: Override the default retry configuration for this method

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v2/client_with_error_tracking.py

@@ -99,7 +99,7 @@ class _AttachmentsWithUpload(_ResourceWithBetterErrors):
             resp = httpx.put(init.upload_url, content=f.read(), headers={"Content-Type": content_type})
         if resp.status_code != 200:
             raise RuntimeError(f"File upload failed with status {resp.status_code}")
-        self._resource.finalize(id=init.id, request_body={})
+        self._resource.finalize(id=init.id)
         return init.id
 
     def download(self, attachment, dest: Union[str, Path, None] = None) -> Path:

{tofupilot-2.2.2 → tofupilot-2.2.3}/tofupilot/v2/models/__init__.py

@@ -263,6 +263,8 @@ if TYPE_CHECKING:
         RunCreateAggregationValidator,
         RunCreateAggregationValidatorOutcome,
         RunCreateAggregationValidatorTypedDict,
+        RunCreateExpectedValue,
+        RunCreateExpectedValueTypedDict,
         RunCreateLevel,
         RunCreateLog,
         RunCreateLogTypedDict,
@@ -283,15 +285,11 @@ if TYPE_CHECKING:
         RunCreateResponseTypedDict,
         RunCreateUnits,
         RunCreateUnitsTypedDict,
+        RunCreateValidator,
+        RunCreateValidatorOutcome,
+        RunCreateValidatorTypedDict,
         RunCreateValue,
         RunCreateValueTypedDict,
-        Validators,
-        ValidatorsExpectedValue,
-        ValidatorsExpectedValueTypedDict,
-        ValidatorsOutcome,
-        ValidatorsTypedDict,
-        ValidatorsUnion,
-        ValidatorsUnionTypedDict,
         XAxis,
         XAxisAggregation,
         XAxisAggregationExpectedValue,
@@ -857,6 +855,8 @@ __all__ = [
     "RunCreateAggregationValidator",
     "RunCreateAggregationValidatorOutcome",
     "RunCreateAggregationValidatorTypedDict",
+    "RunCreateExpectedValue",
+    "RunCreateExpectedValueTypedDict",
     "RunCreateLevel",
     "RunCreateLog",
     "RunCreateLogTypedDict",
@@ -877,6 +877,9 @@ __all__ = [
     "RunCreateResponseTypedDict",
     "RunCreateUnits",
     "RunCreateUnitsTypedDict",
+    "RunCreateValidator",
+    "RunCreateValidatorOutcome",
+    "RunCreateValidatorTypedDict",
     "RunCreateValue",
     "RunCreateValueTypedDict",
     "RunDeleteRequest",
@@ -1111,13 +1114,6 @@ __all__ = [
     "UserListRequestTypedDict",
     "UserListResponse",
     "UserListResponseTypedDict",
-    "Validators",
-    "ValidatorsExpectedValue",
-    "ValidatorsExpectedValueTypedDict",
-    "ValidatorsOutcome",
-    "ValidatorsTypedDict",
-    "ValidatorsUnion",
-    "ValidatorsUnionTypedDict",
     "XAxis",
     "XAxisAggregation",
     "XAxisAggregationExpectedValue",
@@ -1362,6 +1358,8 @@ _dynamic_imports: dict[str, str] = {
     "RunCreateAggregationValidator": ".run_createop",
     "RunCreateAggregationValidatorOutcome": ".run_createop",
     "RunCreateAggregationValidatorTypedDict": ".run_createop",
+    "RunCreateExpectedValue": ".run_createop",
+    "RunCreateExpectedValueTypedDict": ".run_createop",
     "RunCreateLevel": ".run_createop",
     "RunCreateLog": ".run_createop",
     "RunCreateLogTypedDict": ".run_createop",
@@ -1382,15 +1380,11 @@ _dynamic_imports: dict[str, str] = {
     "RunCreateResponseTypedDict": ".run_createop",
     "RunCreateUnits": ".run_createop",
     "RunCreateUnitsTypedDict": ".run_createop",
+    "RunCreateValidator": ".run_createop",
+    "RunCreateValidatorOutcome": ".run_createop",
+    "RunCreateValidatorTypedDict": ".run_createop",
     "RunCreateValue": ".run_createop",
     "RunCreateValueTypedDict": ".run_createop",
-    "Validators": ".run_createop",
-    "ValidatorsExpectedValue": ".run_createop",
-    "ValidatorsExpectedValueTypedDict": ".run_createop",
-    "ValidatorsOutcome": ".run_createop",
-    "ValidatorsTypedDict": ".run_createop",
-    "ValidatorsUnion": ".run_createop",
-    "ValidatorsUnionTypedDict": ".run_createop",
     "XAxis": ".run_createop",
     "XAxisAggregation": ".run_createop",
     "XAxisAggregationExpectedValue": ".run_createop",