RAISE Suite SDK
A Python SDK that enables local devices to communicate with a local RAISE Suite Agent over MQTT. It provides a clean, type-safe wrapper around paho-mqtt v2 for connecting, publishing, subscribing, and handling device messages.
Features
- Modern Packaging: Fully managed via Poetry with
pyproject.toml. - Clean Namespace: Main class exposed via
from raise_suite_sdk import MqttClient. - Robust Logging: Zero direct terminal spam. All communications use structured standard Python logging under
raise_suite_sdk. - Type Hints: Full PEP 484 type signatures for enhanced IDE autocomplete.
Installation
Using Poetry:
poetry add raise-suite-sdk
Or pip:
pip install raise-suite-sdk
Quick Start
import logging
from raise_suite_sdk import MqttClient
# Configure logging in your parent application
logging.basicConfig(level=logging.INFO)
# Define callback
def on_message_received(topic: str, payload: dict, qos: int):
print(f"Received message from {topic}: {payload}")
# Initialize and start the client
client = MqttClient(
client_id="my-app-client",
user="my_username",
password="my_password",
broker="localhost",
port=1883,
on_message=on_message_received
)
client.start()
# Publish a dictionary payload (automatically serialized to JSON)
client.publish("my/topic", {"status": "ok"}, qos=1)
# Stop the client when done
client.stop()
License
Licensed under the European Union Public Licence 1.2 (EUPL-1.2). See LICENSE for the full text.
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 raise_suite_sdk-0.1.0.tar.gz.
File metadata
- Download URL: raise_suite_sdk-0.1.0.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55f1bec3b615616e18ca4649914a64070ab87d4947dde91bc8983ec2d63b825c
|
|
| MD5 |
fb06570880b2e6b800070592ffaf8635
|
|
| BLAKE2b-256 |
61e6f24b85b4028506f3832ddbd449f3e695221234b41a2c5017616ea15598a0
|
Provenance
The following attestation bundles were made for raise_suite_sdk-0.1.0.tar.gz:
Publisher:
ci.yml on cyclopt-pc/raise-suite-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
raise_suite_sdk-0.1.0.tar.gz -
Subject digest:
55f1bec3b615616e18ca4649914a64070ab87d4947dde91bc8983ec2d63b825c - Sigstore transparency entry: 2845938122
- Sigstore integration time:
-
Permalink:
cyclopt-pc/raise-suite-sdk@ad368f6d9dcb44fe7a76e9e0814e0eff3db3df9d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cyclopt-pc
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@ad368f6d9dcb44fe7a76e9e0814e0eff3db3df9d -
Trigger Event:
push
-
Statement type:
File details
Details for the file raise_suite_sdk-0.1.0-py3-none-any.whl.
File metadata
- Download URL: raise_suite_sdk-0.1.0-py3-none-any.whl
- Upload date:
- Size: 13.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7542567fc3539dd52e26b73fa5a11f11a7e848dfdedb5a5b738d91b80ba6a864
|
|
| MD5 |
73f66df3e1b15d6382c354defabf3a67
|
|
| BLAKE2b-256 |
e9179306a282f4b33ccacfedfb32b00fc6f9c6bd33ede958756375cc92566345
|
Provenance
The following attestation bundles were made for raise_suite_sdk-0.1.0-py3-none-any.whl:
Publisher:
ci.yml on cyclopt-pc/raise-suite-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
raise_suite_sdk-0.1.0-py3-none-any.whl -
Subject digest:
7542567fc3539dd52e26b73fa5a11f11a7e848dfdedb5a5b738d91b80ba6a864 - Sigstore transparency entry: 2845938243
- Sigstore integration time:
-
Permalink:
cyclopt-pc/raise-suite-sdk@ad368f6d9dcb44fe7a76e9e0814e0eff3db3df9d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cyclopt-pc
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@ad368f6d9dcb44fe7a76e9e0814e0eff3db3df9d -
Trigger Event:
push
-
Statement type: