Metadata-Version: 2.4
Name: tofupilot
Version: 2.0.6
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)

The official open-source 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:
    client.runs.create(
        procedure_id="FVT1",
        serial_number="SN001",
        part_number="PN001",
        outcome="PASS",
    )
```

## Documentation

- [Getting Started](https://tofupilot.com/docs/dashboard)
- [API Reference](https://tofupilot.com/docs/dashboard/api/v2)
- [Changelog](https://tofupilot.com/changelog)

## Authentication

Set your API key as an environment variable:

```bash
export TOFUPILOT_API_KEY="your-api-key"
```

Or pass it directly when initializing the client.

## Contributing

Please read [CONTRIBUTING](https://github.com/tofupilot/python-client/blob/main/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.

## License

MIT - see [LICENSE](https://github.com/tofupilot/python-client/blob/main/LICENSE) for details.

