Python client for the TIREMO SDK REST and live WebSocket APIs
Project description
tiremo-sdk-client
Official Python client for the TIREMO SDK — REST bootstrap plus an async WebSocket live channel for telemetry, presence, and alarms.
Requires Python 3.10+.
Documentation
| Topic | Link |
|---|---|
| SDK Live Data | docs.tiremo.ai/developer-guide/sdk-live-data |
| API Key Security | docs.tiremo.ai/developer-guide/sdk-api-key-security |
| Source & issues | TIREMO-SDK-CLIENT |
Install
pip install tiremo-sdk-client
From source (development):
make venv lint # creates .venv and installs editable package
# or from repo root: make install-python
pip install .
Usage
import asyncio
from tiremo_sdk import TiremoClient
async def main() -> None:
client = TiremoClient(
api_key="your-api-key",
base_url="https://sdk.tiremo.ai",
)
latest = await client.get_telemetry_latest("device-123", keys=["temperature"])
print(latest)
token_response = await client.create_live_token()
live = client.connect_live_with_token(token_response["token"])
async def on_telemetry(event: dict) -> None:
print(event["data"])
live.on("telemetry", on_telemetry)
await live.connect()
await live.subscribe_telemetry("temp", "device-123", keys=["temperature"])
await asyncio.sleep(60)
await live.disconnect()
asyncio.run(main())
Related packages
| Package | Use case |
|---|---|
@empa-electronics/tiremo-sdk-client-js |
Browser / bundler |
@empa-electronics/tiremo-sdk-client-node |
Node.js 18+ |
Release
Uses a local .venv (Python 3.12 by default — avoids Homebrew 3.14 pyexpat issues on macOS).
make venv
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=<pypi-api-token>
make release # bumps patch in pyproject.toml, builds, uploads
To bump version only: make patch
CI: bump version in pyproject.toml, commit, push tag client-python/v<version> (PyPI Trusted Publishing → workflow publish-client-python.yml).
License
ISC — Empa Electronics
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tiremo_sdk_client-0.1.1.tar.gz.
File metadata
- Download URL: tiremo_sdk_client-0.1.1.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9d12720173178517c71f6b470bd4e0280e66aac0b76b282ded8a78cddff1d92
|
|
| MD5 |
f3a7e3b12185e2df6c5f39c29518d766
|
|
| BLAKE2b-256 |
a2d96efdd6635562d32111d7defab61e6b429f6d55305a4ef216b6eea4f8ca62
|
File details
Details for the file tiremo_sdk_client-0.1.1-py3-none-any.whl.
File metadata
- Download URL: tiremo_sdk_client-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93249dfa93fa479e06e1a2c1bf7b208b607a33bcd4f04cc71a19f19110a802f8
|
|
| MD5 |
bfddfdcd6ac2ce420f31e8d6307fda2c
|
|
| BLAKE2b-256 |
6052ff54badc62784389b4da4d26bb92d129cd07bab7e130610c82a813f8c348
|