Skip to main content

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 v5 (using asyncio-mqtt).
  • 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/#'
poetry run uns-kit-py write-config --path config.json

Quick start

import asyncio
from uns_kit import UnsConfig, UnsPacket, UnsProxyProcess

async def main():
    process = UnsProxyProcess("mqtt-broker", config=UnsConfig(host="mqtt-broker"))
    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())

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 sandbox app in this repo

From the monorepo root:

pnpm run py:sandbox

This creates sandbox-app-py/ using the default Python template.

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}.

TODO (parity with TS core)

  • Handover manager (cross-version active detection + handover_* messages).
  • Publish throttling/queue.
  • Status parity (publisher/subscriber active flags everywhere, richer metrics).
  • API endpoints registry (to mirror @uns-kit/api produced endpoints).
  • Optional: dictionary/measurement helpers + CLI wrapper.

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

uns_kit-0.0.6.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uns_kit-0.0.6-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file uns_kit-0.0.6.tar.gz.

File metadata

  • Download URL: uns_kit-0.0.6.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.1.0

File hashes

Hashes for uns_kit-0.0.6.tar.gz
Algorithm Hash digest
SHA256 94e6d9c09e9adcd7d5f24dcc761ac56cecf3ed35b900c25908e44cabe826314c
MD5 8273fb6fd5fc386847fe42aa63d77bb1
BLAKE2b-256 5ee8aecb6a3b2fb2bc0b0180756c7766c12a4c697cd7784abbbffd1944d00fd1

See more details on using hashes here.

File details

Details for the file uns_kit-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: uns_kit-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.1.0

File hashes

Hashes for uns_kit-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 11bfcf89c00d49f7b50fdde12db5659f7b98afcdfd23dbed00a04757e8c2082e
MD5 26dbb1e12a23e07e50071cd6a8811edf
BLAKE2b-256 6ac74cb65c6bbce753d4dbfc5737a755602dee507e9df8195f4ab81e94c11542

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page