Lightweight Python UNS MQTT client (pub/sub + infra topics)
Project description
uns-kit (Python)
Lightweight UNS MQTT client for Python. Provides:
- Topic builder compatible with UNS infra topics (
uns-infra/<package>/<version>/<process>/). - Async publish/subscribe via MQTT (using
aiomqtt). - Process + instance status topics (active/heap/uptime/alive + stats).
- Minimal UNS packet builder/parser (data/table) aligned with TS core.
Install (editable)
cd packages/uns-py
poetry install
CLI
After poetry install, an uns-kit-py command is available (renamed to avoid clashing with the Node CLI):
poetry run uns-kit-py publish --host localhost:1883 --topic raw/data/ --value 1
poetry run uns-kit-py subscribe --host localhost:1883 --topic 'uns-infra/#'
Quick start
import asyncio
from pathlib import Path
from uns_kit import ConfigFile, UnsPacket, UnsProcessParameters, UnsProxyProcess
async def main():
config = ConfigFile.load_config(Path("config.json"))
infra = config["infra"]
uns = config["uns"]
process = UnsProxyProcess(
infra["host"],
UnsProcessParameters(process_name=uns.get("processName", "uns-process")),
)
await process.start()
mqtt = await process.create_mqtt_proxy("py")
# Subscribe
async with mqtt.client.messages("uns-infra/#") as messages:
await mqtt.publish_packet("raw/data/", UnsPacket.data(value=1, uom="count"))
msg = await messages.__anext__()
print(msg.topic, msg.payload.decode())
await mqtt.close()
await process.stop()
asyncio.run(main())
Config placeholders (env + Infisical)
uns-py now resolves config placeholders in the same style as uns-core.
For Infisical placeholders, install the optional extra:
pip install "uns-kit[infisical]"
Example config.json:
{
"uns": {
"graphql": "https://example/graphql",
"rest": "https://example/rest",
"email": "service@example.com",
"password": { "provider": "env", "key": "UNS_PASSWORD" },
"processName": "my-process"
},
"infra": {
"host": "mqtt.example.local",
"port": 1883,
"username": "mqtt-user",
"password": {
"provider": "infisical",
"path": "/mqtt",
"key": "password",
"environment": "dev"
}
}
}
Load resolved config with cache semantics:
from uns_kit import ConfigFile, SecretResolverOptions, InfisicalResolverOptions
resolved = ConfigFile.load_config(
"config.json",
SecretResolverOptions(
infisical=InfisicalResolverOptions(
environment="dev",
project_id="your-project-id"
)
)
)
Resilient subscriber
async for msg in client.resilient_messages("uns-infra/#"):
print(msg.topic, msg.payload.decode())
Examples
examples/publish.py— publish 5 data packets.examples/subscribe.py— resilient subscription with auto-reconnect.examples/load_test.py— interactive publish burst.
Create a new project
uns-kit-py create my-uns-py-app
cd my-uns-py-app
poetry install
poetry run python src/main.py
Create a new project from a service bundle
uns-kit-py create --bundle ./service.bundle.json
uns-kit-py create --bundle ./service.bundle.json --dest ./my-dir
uns-kit-py create --bundle ./service.bundle.json --dest . --allow-existing
Bundle-driven create uses service.bundle.json as the source of truth. The Python CLI:
- scaffolds the base Python app from the existing default template
- copies the original bundle into the project root as
service.bundle.json - generates
SERVICE_SPEC.mdandAGENTS.md - applies supported bundle features such as
vscodeanddevops
When --bundle is used, the default destination is ./<metadata.name>. The Python CLI only accepts bundles with scaffold.stack = "python" and currently supports scaffold.template = "default" for this MVP. If the bundle targets TypeScript instead, use uns-kit create --bundle ....
Create a sandbox app in this repo
From the monorepo root:
pnpm run py:sandbox
This creates sandbox-app-py/ using the default Python template.
When created inside this monorepo, pyproject.toml is automatically set to use local editable uns-kit:
uns-kit = { path = "../packages/uns-py", develop = true }.
Notes
- Default QoS is 0.
- Instance status topics are published every 10 seconds; stats every 60 seconds.
- Packet shape mirrors the TypeScript core:
{"version":"1.3.0","message":{"data":{...}},"sequenceId":0}. - Windows: the library sets
WindowsSelectorEventLoopPolicy()to avoidadd_reader/add_writerNotImplementedError.
TODO (parity with TS core)
- Handover manager parity: subscribe to wildcard
activeandhandovertopics, keep new instances passive until timeout or handover completion, and supporthandover_intent,handover_request,handover_subscriber,handover_fin, andhandover_ack. - Publish throttling / queue parity: add buffered ordered publishing instead of direct proxy-path publish, plus publisher/subscriber active-passive controls and passive-drain behavior.
- Status parity: add process-level
aliveanduptime, publisher/subscriber active flags everywhere, published/subscribed message count and byte metrics, and process identity on active status packets. - API endpoints registry: mirror
@uns-kit/apiproduced endpoints when Python gets an API surface, and use full UNS identity for endpoint keys and paths:topic + asset + objectType + objectId + attribute. - Optional: dictionary/measurement helpers + CLI wrapper.
Project details
Release history Release notifications | RSS feed
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 uns_kit-0.0.39.tar.gz.
File metadata
- Download URL: uns_kit-0.0.39.tar.gz
- Upload date:
- Size: 38.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.2.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
285c03f18b74fc7de1ea73459dcb5e7317fecd055f723848e7facbea54fe568e
|
|
| MD5 |
2220c19f77eacba2c9dabdb59b11029e
|
|
| BLAKE2b-256 |
2715ab8912aeafaa98a38b43a8a73e9a355a94186bc0f84a51ac06277253b6a7
|
File details
Details for the file uns_kit-0.0.39-py3-none-any.whl.
File metadata
- Download URL: uns_kit-0.0.39-py3-none-any.whl
- Upload date:
- Size: 46.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.2.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
224ac741a8ba1734352abbffe08b875d07142058b0ca52f93996ce2515d0b429
|
|
| MD5 |
0a2a6f20c9b40773fd2b3d288fd2934e
|
|
| BLAKE2b-256 |
f40ec30eccf195d2cb26a07a31cb5f9afea4527a25bf4c15cb5452bfc259559b
|