uns-kit 0.2.3__tar.gz → 0.2.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. {uns_kit-0.2.3 → uns_kit-0.2.5}/PKG-INFO +30 -11
  2. {uns_kit-0.2.3 → uns_kit-0.2.5}/README.md +503 -484
  3. {uns_kit-0.2.3 → uns_kit-0.2.5}/pyproject.toml +42 -42
  4. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/__init__.py +184 -172
  5. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/api/event_routing.py +0 -3
  6. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/api/proxy.py +638 -638
  7. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/cli.py +1268 -1268
  8. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/__init__.py +140 -128
  9. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/auth_client.py +173 -173
  10. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/client.py +350 -350
  11. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/config_file.py +58 -58
  12. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/config_schema.py +452 -452
  13. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/datahub_client.py +520 -509
  14. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/events.py +23 -23
  15. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/logger.py +149 -149
  16. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/packet.py +464 -464
  17. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/proxy.py +87 -87
  18. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/proxy_process.py +335 -335
  19. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/proxy_process_sync.py +339 -339
  20. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/runtime_metadata.py +45 -45
  21. uns_kit-0.2.5/src/uns_kit/core/runtime_service_registration.py +103 -0
  22. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/secret_resolver.py +482 -482
  23. uns_kit-0.2.5/src/uns_kit/core/service_token_provider.py +69 -0
  24. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/state.py +53 -53
  25. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/status_monitor.py +88 -88
  26. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/topic_builder.py +70 -71
  27. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/topic_matcher.py +18 -18
  28. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/uns_mqtt_proxy.py +476 -476
  29. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/uns_path.py +17 -17
  30. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/cron/proxy.py +137 -137
  31. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/client.py +251 -251
  32. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/schema.py +10 -1
  33. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/service_bundle.py +373 -373
  34. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/api/src/api_routes.py +82 -82
  35. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/api/src/main.py +64 -64
  36. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/azure-pipelines.yml +21 -21
  37. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/cron/src/cron_example.py +52 -52
  38. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/api_routes.py +91 -91
  39. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/data_offers/demo_coils.py +70 -70
  40. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/data_offers/demo_export.py +87 -87
  41. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/main.py +67 -67
  42. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/.gitignore +47 -47
  43. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/README.md +99 -99
  44. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/package.json +14 -14
  45. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/pyproject.toml +14 -14
  46. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/runtime.json +3 -3
  47. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/src/config/project_config_extension.example.py +32 -32
  48. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/src/config/project_config_extension.py +9 -9
  49. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/default/src/main.py +55 -55
  50. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/vscode/extensions.json +6 -6
  51. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/vscode/launch.json +13 -13
  52. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/vscode/settings.json +5 -5
  53. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/workspace/workspace.json +10 -10
  54. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/version.py +19 -19
  55. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/api/__init__.py +0 -0
  56. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/api/data_catalog.py +0 -0
  57. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/api/interfaces.py +0 -0
  58. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/core/secure_store.py +0 -0
  59. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/cron/__init__.py +0 -0
  60. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/__init__.py +0 -0
  61. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/params.py +0 -0
  62. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/sql.py +0 -0
  63. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/database/types.py +0 -0
  64. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/data_offers/__init__.py +0 -0
  65. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/data_offers/sql/demo_coils.sql +0 -0
  66. {uns_kit-0.2.3 → uns_kit-0.2.5}/src/uns_kit/templates/data-offer/src/data_offers/sql/demo_export.sql +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: uns-kit
3
- Version: 0.2.3
3
+ Version: 0.2.5
4
4
  Summary: Lightweight Python UNS MQTT client (pub/sub + infra topics)
5
5
  License: MIT
6
6
  Author: Aljoša Vister
@@ -27,7 +27,7 @@ Requires-Dist: oracledb (>=2.5.1,<3.0.0) ; extra == "database"
27
27
  Requires-Dist: pandas (>=2.3.3,<3.0.0) ; extra == "api"
28
28
  Requires-Dist: psycopg[binary] (>=3.2.9,<4.0.0) ; extra == "database"
29
29
  Requires-Dist: pyarrow (>=21.0.0,<22.0.0) ; extra == "api"
30
- Requires-Dist: pyjwt[crypto] (>=2.10.1,<3.0.0) ; extra == "api"
30
+ Requires-Dist: pyjwt[crypto] (>=2.13.0,<3.0.0) ; extra == "api"
31
31
  Requires-Dist: uvicorn (>=0.35.0,<0.36.0) ; extra == "api"
32
32
  Description-Content-Type: text/markdown
33
33
 
@@ -271,19 +271,19 @@ separate physical table family while the UNS path still comes from
271
271
 
272
272
  ### Datahub client (last value + history)
273
273
 
274
- `UnsClient` provides a minimal REST client for the UNS OpenHub API, including batch last-value, single-topic catch-all history, and batch range endpoints. For service-to-service access, prefer passing a long-lived service token directly. Use `AuthClient` only when you need user-style login/refresh from `config.json`.
274
+ `UnsClient` provides a minimal REST client for the UNS OpenHub API, including batch last-value, single-topic catch-all history, and batch range endpoints. A controller-managed RTT service should use `ServiceTokenProvider`; it reads the short-lived token file mounted by the controller for every request. Direct local development can use `.env`/exported `UNS_SERVICE_TOKEN`, a resolved `uns.token`, or an explicit `AuthClient` fallback.
275
275
 
276
276
  ```python
277
277
  import pandas as pd
278
278
  from pathlib import Path
279
- from uns_kit.core import ConfigFile, UnsClient
279
+ from uns_kit.core import ConfigFile, ServiceTokenProvider, UnsClient
280
280
  import io
281
281
 
282
282
  cfg = ConfigFile.load_config(Path("config.json"))
283
283
  client = UnsClient(
284
284
  cfg["uns"]["rest"],
285
285
  api_base_path="/api",
286
- token=cfg["uns"].get("token"),
286
+ token_provider=ServiceTokenProvider(config_token=cfg["uns"].get("token")),
287
287
  )
288
288
 
289
289
  values = client.last_value([
@@ -331,10 +331,13 @@ When several modules in one application use the same REST client, register it
331
331
  once during startup and retrieve the same named instance wherever it is needed:
332
332
 
333
333
  ```python
334
- from uns_kit import get_uns_client, register_uns_client
334
+ from uns_kit import ServiceTokenProvider, get_uns_client, register_uns_client
335
335
 
336
336
  # application startup
337
- register_uns_client(cfg["uns"]["rest"], token=cfg["uns"].get("token"))
337
+ register_uns_client(
338
+ cfg["uns"]["rest"],
339
+ token_provider=ServiceTokenProvider(config_token=cfg["uns"].get("token")),
340
+ )
338
341
 
339
342
  # handler or another application module
340
343
  client = get_uns_client()
@@ -345,15 +348,31 @@ Use distinct names when the application needs clients for more than one UNS
345
348
  OpenHub endpoint: `register_uns_client(url, name="secondary")` and
346
349
  `get_uns_client("secondary")`.
347
350
 
348
- If your service token comes from an environment variable or secret store, resolve it before constructing the client:
351
+ For a directly started local service, load its `.env` by the application and use the provider. Do not set `RTT_NODE` or `RTT_INSTANCE_ID` yourself; those identifiers are injected only by the controller.
349
352
 
350
353
  ```python
351
- import os
352
- from uns_kit.core import UnsClient
354
+ from uns_kit.core import ServiceTokenProvider, UnsClient
353
355
 
354
356
  client = UnsClient(
355
357
  "https://datahub.example.com",
356
- token=os.environ["UNS_SERVICE_TOKEN"],
358
+ token_provider=ServiceTokenProvider(),
359
+ )
360
+ ```
361
+
362
+ After a Python service has successfully started its MQTT/API runtime, it can register its non-secret descriptor when managed by the controller. This is a no-op in direct local development:
363
+
364
+ ```python
365
+ from uns_kit.core import RuntimeServiceDescriptor, register_service
366
+
367
+ register_service(
368
+ client,
369
+ RuntimeServiceDescriptor(
370
+ id="uns-example",
371
+ version="1.2.3",
372
+ capabilities=["example-api"],
373
+ health_contract="service-metadata-v1",
374
+ process_name="uns-example",
375
+ ),
357
376
  )
358
377
  ```
359
378