tofupilot 1.12.1

Official Python client for TofuPilot with OpenHTF integration, real-time streaming and file attachment support

TofuPilot Python client

The official open-source Python client for TofuPilot. Quickly and seamlessly integrate all your hardware test runs into one app with just a few lines of Python.

Table of Contents

• Installation
• Usage
• Contributing
• License
• Contact

Installation

Package can be installed via pip

pip install tofupilot

Usage

Documentation

You can find the full TofuPilot documentation here.

Examples

For usage examples, see the examples.

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE for details.

Contact

If you have any questions or feedback, feel free to open an issue or contact us at [e-mail].

Summary

TofuPilot APIv2: TofuPilot REST API for managing runs, units, procedures, and more.

More information about the API can be found at https://tofupilot.com/docs/api/v2

Table of Contents

• TofuPilot Python client
  • Installation
  • Usage
  • Contributing
  • License
  • Contact
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging

SDK Installation

[!TIP] To finish publishing your SDK to PyPI you must run your first generation action.

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from tofupilot.v2 python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "tofupilot.v2",
# ]
# ///

from tofupilot.v2 import TofuPilot

sdk = TofuPilot(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import parse_datetime


with TofuPilot(
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:

    res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import parse_datetime

async def main():

    async with TofuPilot(
        api_key=os.getenv("TOFUPILOT_API_KEY", ""),
    ) as tofu_pilot:

        res = await tofu_pilot.procedures.list_async(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
api_key	http	HTTP Bearer	TOFUPILOT_API_KEY

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import parse_datetime


with TofuPilot(
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:

    res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

    # Handle response
    print(res)

Available Resources and Operations

Available methods

attachments

• initialize - Initialize upload
• delete - Delete attachments

batches

• get - Get batch
• delete - Delete batch
• update - Update batch
• list - List and filter batches
• create - Create batch

parts

• list - List and filter parts
• create - Create part
• get - Get part
• update - Update part

parts.revisions

• list - List revisions for a part
• create - Create revision for a part
• get - Get revision for a part
• delete - Delete revision for a part
• update - Update revision for a part

procedures

• list - List and filter procedures
• create - Create procedure
• get - Get procedure
• delete - Delete procedure
• update - Update procedure

procedures.versions

• list - List versions for a procedure
• create - Create version for a procedure
• get - Get version for a procedure
• delete - Delete version for a procedure

runs

• list - List and filter runs
• create - Create run
• delete - Delete runs
• get - Get run
• update - Update run

stations

• list - List and filter stations
• create - Create station
• get - Get station
• remove - Remove station
• update - Update station
• link_procedure - Link procedure to station
• unlink_procedure - Unlink procedure from station

units

• list - List and filter units
• create - Create unit
• delete - Delete units
• get - Get unit
• update - Update unit
• add_child - Add child to unit
• remove_child - Remove child from unit

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import BackoffStrategy, RetryConfig, parse_datetime


with TofuPilot(
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:

    res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"),
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import BackoffStrategy, RetryConfig, parse_datetime


with TofuPilot(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:

    res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

    # Handle response
    print(res)

Error Handling

TofuPilotError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

import os
from tofupilot.v2 import TofuPilot, errors
from tofupilot.v2.utils import parse_datetime


with TofuPilot(
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:
    res = None
    try:

        res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

        # Handle response
        print(res)


    except errors.TofuPilotError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ERRORINTERNALSERVERERROR):
            print(e.data.message)  # str
            print(e.data.code)  # str
            print(e.data.issues)  # Optional[List[models.ERRORINTERNALSERVERERRORIssue]]

Error Classes

Primary errors:

• TofuPilotError: The base class for HTTP error responses.
  • ERRORINTERNALSERVERERROR: The error information. Status code 500.

Less common errors (12)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from TofuPilotError:

• ErrorNOTFOUND: The error information. Status code 404. Applicable to 32 of 44 methods.*
• ErrorCONFLICT: The error information. Status code 409. Applicable to 11 of 44 methods.*
• ErrorBADREQUEST: The error information. Status code 400. Applicable to 8 of 44 methods.*
• ErrorFORBIDDEN: The error information. Status code 403. Applicable to 4 of 44 methods.*
• ErrorUNAUTHORIZED: The error information. Status code 401. Applicable to 2 of 44 methods.*
• ErrorUNPROCESSABLECONTENT: The error information. Status code 422. Applicable to 1 of 44 methods.*
• ErrorBADGATEWAY: The error information. Status code 502. Applicable to 1 of 44 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import os
from tofupilot.v2 import TofuPilot
from tofupilot.v2.utils import parse_datetime


with TofuPilot(
    server_url="http://localhost:3000/api",
    api_key=os.getenv("TOFUPILOT_API_KEY", ""),
) as tofu_pilot:

    res = tofu_pilot.procedures.list(limit=20, cursor=50, search_query="battery test", created_after=parse_datetime("2024-01-01T00:00:00.000Z"), created_before=parse_datetime("2024-12-31T23:59:59.999Z"))

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from tofupilot.v2 import TofuPilot
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = TofuPilot(client=http_client)

or you could wrap the client with your own custom logic:

from tofupilot.v2 import TofuPilot
from tofupilot.v2.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = TofuPilot(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The TofuPilot class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

import os
from tofupilot.v2 import TofuPilot
def main():

    with TofuPilot(
        api_key=os.getenv("TOFUPILOT_API_KEY", ""),
    ) as tofu_pilot:
        # Rest of application here...


# Or when using async:
async def amain():

    async with TofuPilot(
        api_key=os.getenv("TOFUPILOT_API_KEY", ""),
    ) as tofu_pilot:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from tofupilot.v2 import TofuPilot
import logging

logging.basicConfig(level=logging.DEBUG)
s = TofuPilot(debug_logger=logging.getLogger("tofupilot.v2"))

You can also enable a default debug logger by setting an environment variable TOFUPILOT_DEBUG to true.