Metadata-Version: 2.4
Name: rocketride
Version: 1.4.0
Summary: RocketRide Pipeline Python Client SDK
Author-email: "RocketRide, Inc." <dev@rocketride.ai>
Maintainer-email: "RocketRide, Inc." <dev@rocketride.ai>
License-Expression: MIT
Project-URL: Homepage, https://github.com/rocketride-ai/rocketride-server
Project-URL: Documentation, https://github.com/rocketride-ai/rocketride-server#readme
Project-URL: Repository, https://github.com/rocketride-ai/rocketride-server.git
Project-URL: Bug Reports, https://github.com/rocketride-ai/rocketride-server/issues
Keywords: rocketride,pipeline,dap,debug-adapter-protocol,data-processing,client-sdk,async,websocket
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Classifier: Topic :: Internet :: WWW/HTTP
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.13
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: websockets>=11.0.0
Requires-Dist: aiofiles>=23.0.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pathspec>=0.12.0
Requires-Dist: typing_extensions>=4.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: ruff>=0.8.0; extra == "dev"
Requires-Dist: build>=0.10.0; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Requires-Dist: rocketride[otel]; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Requires-Dist: python-dotenv>=1.0.0; extra == "test"
Requires-Dist: rocketride[otel]; extra == "test"
Provides-Extra: otel
Requires-Dist: opentelemetry-sdk>=1.27.0; extra == "otel"
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.27.0; extra == "otel"
Dynamic: license-file

<!-- GENERATED by `./builder docs:export` — DO NOT EDIT. Source: docs/public/python/README.md -->

# RocketRide Python SDK

<p align="center">
  <img src="https://raw.githubusercontent.com/rocketride-org/rocketride-server/main/docs/public/python/assets/banner-python.png" alt="RocketRide Python SDK" width="900">
</p>

<p align="center">
  Build, run, and manage AI pipelines from Python.
</p>

<p align="center">
  <a href="https://pypi.org/project/rocketride/"><img src="https://img.shields.io/pypi/v/rocketride?color=222223&label=PyPI" alt="PyPI"></a>
  <a href="https://github.com/rocketride-org/rocketride-server"><img src="https://img.shields.io/github/stars/rocketride-org/rocketride-server?style=flat&color=238636&label=GitHub&logo=github&logoColor=white" alt="GitHub"></a>
  <a href="https://discord.gg/PMXrtenMsY"><img src="https://img.shields.io/badge/Discord-Join-370b7a?logo=discord&logoColor=white" alt="Discord"></a>
  <a href="https://github.com/rocketride-org/rocketride-server/blob/develop/LICENSE"><img src="https://img.shields.io/badge/License-MIT-41b6e6" alt="MIT License"></a>
</p>

**Full documentation: [docs.rocketride.org/clients/python](https://docs.rocketride.org/clients/python)** — guides, the complete API reference, and worked examples.

## Quick Start

```bash
pip install rocketride
```

```python
import asyncio
from rocketride import RocketRideClient


async def main():
    async with RocketRideClient(uri='https://api.rocketride.ai', auth='my-key') as client:
        result = await client.use(filepath='pipeline.pipe')
        token = result['token']
        out = await client.send(token, 'Hello, pipeline!', objinfo={'name': 'input.txt'}, mimetype='text/plain')
        print(out)
        await client.terminate(token)


asyncio.run(main())
```

`send()` / `send_files()` are for pipelines whose **source** is `webhook` or `dropper`;
if your pipeline source is `chat`, use `client.chat()` instead. Don't have a pipeline
yet? Build one visually with the [RocketRide IDE extension](https://docs.rocketride.org/quickstart/ide-walkthrough).

The SDK is async-first (built on `asyncio` and `websockets`), includes the
`rocketride` [CLI](https://docs.rocketride.org/connect/cli), and covers the full
engine surface: pipeline execution, streaming data, chat, deployments with cron
schedules, server-side file storage, and run-log replay.

## What is RocketRide?

[RocketRide](https://rocketride.org) is an open-source, developer-native AI pipeline
platform: build, debug, and deploy production AI workflows without leaving your IDE,
on a visual canvas or code-first. 140+ ready-to-use nodes (15+ LLM providers, 10+
vector stores, OCR, NER, PII anonymization) run on a high-performance C++ engine,
deployable anywhere, MIT licensed. You build your `.pipe` — and run it against the
fastest AI runtime available.

## Configuration

| Variable | Description |
| --- | --- |
| `ROCKETRIDE_URI` | Server URI (e.g. `wss://api.rocketride.ai` or `ws://localhost:5565`) |
| `ROCKETRIDE_APIKEY` | API key for authentication |

All constructor options, timeouts, and reconnection behavior:
[Configuration](https://docs.rocketride.org/clients/python/configuration).

## Documentation

- [Overview & quickstart](https://docs.rocketride.org/clients/python)
- [Running pipelines](https://docs.rocketride.org/clients/python/pipelines) · [Sending data](https://docs.rocketride.org/clients/python/data) · [Chat](https://docs.rocketride.org/clients/python/chat)
- [Deployments](https://docs.rocketride.org/clients/python/deploy) · [File storage](https://docs.rocketride.org/clients/python/storage) · [Run logs](https://docs.rocketride.org/clients/python/logs)
- [Error handling](https://docs.rocketride.org/clients/python/errors) · [API reference](https://docs.rocketride.org/clients/python/reference) · [Examples](https://docs.rocketride.org/clients/python/examples)

## Links

- [Documentation](https://docs.rocketride.org/clients/python)
- [GitHub](https://github.com/rocketride-org/rocketride-server)
- [Discord](https://discord.gg/PMXrtenMsY)
- [Release notes](https://docs.rocketride.org/support/release-notes)

## License

MIT - see [LICENSE](https://github.com/rocketride-org/rocketride-server/blob/develop/LICENSE).
