uns-kit 0.0.2__tar.gz → 0.0.4__tar.gz

{uns_kit-0.0.2 → uns_kit-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uns-kit
-Version: 0.0.2
+Version: 0.0.4
 Summary: Lightweight Python UNS MQTT client (pub/sub + infra topics)
 License: MIT
 Author: Aljoša Vister
@@ -32,11 +32,11 @@ poetry install
 ```
 
 ## CLI
-After `poetry install`, a `uns-kit` command is available:
+After `poetry install`, an `uns-kit-py` command is available (renamed to avoid clashing with the Node CLI):
 ```bash
-poetry run uns-kit publish --host localhost:1883 --topic raw/data/ --value 1
-poetry run uns-kit subscribe --host localhost:1883 --topic 'uns-infra/#'
-poetry run uns-kit write-config --path config.json
+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
@@ -70,6 +70,14 @@ async for msg in client.resilient_messages("uns-infra/#"):
 - `examples/publish.py` — publish 5 data packets.
 - `examples/subscribe.py` — resilient subscription with auto-reconnect.
 
+### Create a new project
+```bash
+uns-kit-py create my-uns-py-app
+cd my-uns-py-app
+poetry install
+poetry run python src/main.py
+```
+
 ## Notes
 - Default QoS is 0; will message is retained on `<statusTopic>alive`.
 - Uptime is published every 10 seconds on `<statusTopic>uptime`.

{uns_kit-0.0.2 → uns_kit-0.0.4}/README.md

@@ -13,11 +13,11 @@ poetry install
 ```
 
 ## CLI
-After `poetry install`, a `uns-kit` command is available:
+After `poetry install`, an `uns-kit-py` command is available (renamed to avoid clashing with the Node CLI):
 ```bash
-poetry run uns-kit publish --host localhost:1883 --topic raw/data/ --value 1
-poetry run uns-kit subscribe --host localhost:1883 --topic 'uns-infra/#'
-poetry run uns-kit write-config --path config.json
+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
@@ -51,6 +51,14 @@ async for msg in client.resilient_messages("uns-infra/#"):
 - `examples/publish.py` — publish 5 data packets.
 - `examples/subscribe.py` — resilient subscription with auto-reconnect.
 
+### Create a new project
+```bash
+uns-kit-py create my-uns-py-app
+cd my-uns-py-app
+poetry install
+poetry run python src/main.py
+```
+
 ## Notes
 - Default QoS is 0; will message is retained on `<statusTopic>alive`.
 - Uptime is published every 10 seconds on `<statusTopic>uptime`.

{uns_kit-0.0.2 → uns_kit-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uns-kit"
-version = "0.0.2"
+version = "0.0.4"
 description = "Lightweight Python UNS MQTT client (pub/sub + infra topics)"
 authors = ["Aljoša Vister <aljosa.vister@gmail.com>"]
 license = "MIT"
@@ -19,7 +19,7 @@ ruff = "^0.6.9"
 mypy = "^1.11.2"
 
 [tool.poetry.scripts]
-uns-kit = "uns_kit.cli:main"
+uns-kit-py = "uns_kit.cli:main"
 
 [build-system]
 requires = ["poetry-core"]

{uns_kit-0.0.2 → uns_kit-0.0.4}/src/uns_kit/cli.py

@@ -2,6 +2,9 @@ from __future__ import annotations
 
 import asyncio
 import json
+import os
+import shutil
+import importlib.resources
 from pathlib import Path
 from typing import Optional
 
@@ -120,6 +123,22 @@ async def _run_subscribe(
             print(f"{msg.topic} <binary {len(msg.payload)} bytes>")
 
 
+@cli.command("create", help="Create a new UNS Python app (default template).")
+@click.argument("dest")
+def create(dest: str):
+    template_root = importlib.resources.files("uns_kit").joinpath("templates/default")
+    dest_path = os.path.abspath(dest)
+    if os.path.exists(dest_path):
+        raise click.ClickException(f"Destination already exists: {dest_path}")
+    shutil.copytree(template_root, dest_path)
+    click.echo(f"Created UNS Python app at {dest_path}")
+    click.echo("Next steps:")
+    click.echo(f"  1) cd {dest_path}")
+    click.echo("  2) poetry install")
+    click.echo("  3) poetry run python src/main.py")
+    click.echo("  4) Edit config.json with your MQTT host/credentials")
+
+
 @cli.command("write-config", help="Write a minimal config.json scaffold.")
 @click.option("--path", default="config.json", show_default=True)
 def write_config(path: str):

uns_kit-0.0.4/src/uns_kit/templates/default/README.md

@@ -0,0 +1,10 @@
+# UNS Python App Template
+
+## Setup
+```bash
+poetry install
+poetry run python src/main.py
+```
+
+## Config
+Edit `config.json` with your MQTT host/auth.

uns_kit-0.0.4/src/uns_kit/templates/default/pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "uns-py-app"
+version = "0.1.0"
+description = "Example UNS Python application"
+authors = ["Your Name <you@example.com>"]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "^3.10"
+uns-kit = "*"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

uns_kit-0.0.4/src/uns_kit/templates/default/src/main.py

@@ -0,0 +1,27 @@
+import asyncio
+import json
+from pathlib import Path
+from uns_kit import UnsMqttClient, TopicBuilder, UnsPacket
+
+
+async def main():
+    cfg = json.loads(Path("config.json").read_text())
+    tb = TopicBuilder(cfg["packageName"], cfg["packageVersion"], cfg["processName"])
+    client = UnsMqttClient(
+        cfg["host"],
+        port=cfg.get("port"),
+        username=cfg.get("username") or None,
+        password=cfg.get("password") or None,
+        tls=cfg.get("tls", False),
+        client_id=cfg.get("clientId"),
+        topic_builder=tb,
+        reconnect_interval=1,
+    )
+    await client.connect()
+    await client.publish_packet("raw/data/", UnsPacket.data(value=1, uom="count"))
+    async for msg in client.resilient_messages("uns-infra/#"):
+        print(msg.topic, msg.payload.decode())
+
+
+if __name__ == "__main__":
+    asyncio.run(main())