uns-kit 0.2.1__tar.gz → 0.2.3__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.
- {uns_kit-0.2.1 → uns_kit-0.2.3}/PKG-INFO +44 -2
- {uns_kit-0.2.1 → uns_kit-0.2.3}/README.md +484 -442
- {uns_kit-0.2.1 → uns_kit-0.2.3}/pyproject.toml +42 -42
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/__init__.py +172 -162
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/api/proxy.py +638 -638
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/cli.py +1268 -1231
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/__init__.py +128 -118
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/auth_client.py +173 -173
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/client.py +350 -350
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/config_file.py +58 -58
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/config_schema.py +452 -452
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/datahub_client.py +509 -417
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/events.py +23 -23
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/logger.py +149 -149
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/packet.py +464 -464
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/proxy.py +87 -87
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/proxy_process.py +335 -335
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/proxy_process_sync.py +339 -339
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/runtime_metadata.py +45 -45
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/secret_resolver.py +482 -482
- uns_kit-0.2.3/src/uns_kit/core/state.py +53 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/status_monitor.py +88 -88
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/topic_builder.py +71 -71
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/topic_matcher.py +18 -18
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/uns_mqtt_proxy.py +476 -476
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/uns_path.py +17 -17
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/cron/proxy.py +137 -137
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/client.py +251 -251
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/service_bundle.py +373 -373
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/api/src/api_routes.py +82 -82
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/api/src/main.py +64 -64
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/azure-pipelines.yml +21 -21
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/cron/src/cron_example.py +52 -52
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/api_routes.py +91 -91
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/data_offers/demo_coils.py +70 -70
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/data_offers/demo_export.py +87 -87
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/main.py +67 -67
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/.gitignore +47 -47
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/README.md +99 -99
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/package.json +14 -9
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/pyproject.toml +14 -14
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/runtime.json +3 -3
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/src/config/project_config_extension.example.py +32 -32
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/src/config/project_config_extension.py +9 -9
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/default/src/main.py +55 -55
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/vscode/extensions.json +6 -6
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/vscode/launch.json +13 -13
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/vscode/settings.json +5 -5
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/workspace/workspace.json +10 -10
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/version.py +19 -19
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/api/__init__.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/api/data_catalog.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/api/event_routing.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/api/interfaces.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/core/secure_store.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/cron/__init__.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/__init__.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/params.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/schema.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/sql.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/database/types.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/data_offers/__init__.py +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/src/uns_kit/templates/data-offer/src/data_offers/sql/demo_coils.sql +0 -0
- {uns_kit-0.2.1 → uns_kit-0.2.3}/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
|
+
Version: 0.2.3
|
|
4
4
|
Summary: Lightweight Python UNS MQTT client (pub/sub + infra topics)
|
|
5
5
|
License: MIT
|
|
6
6
|
Author: Aljoša Vister
|
|
@@ -271,7 +271,7 @@ 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
|
|
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`.
|
|
275
275
|
|
|
276
276
|
```python
|
|
277
277
|
import pandas as pd
|
|
@@ -327,6 +327,24 @@ batch_history = client.history(
|
|
|
327
327
|
print(batch_history.by_topic)
|
|
328
328
|
```
|
|
329
329
|
|
|
330
|
+
When several modules in one application use the same REST client, register it
|
|
331
|
+
once during startup and retrieve the same named instance wherever it is needed:
|
|
332
|
+
|
|
333
|
+
```python
|
|
334
|
+
from uns_kit import get_uns_client, register_uns_client
|
|
335
|
+
|
|
336
|
+
# application startup
|
|
337
|
+
register_uns_client(cfg["uns"]["rest"], token=cfg["uns"].get("token"))
|
|
338
|
+
|
|
339
|
+
# handler or another application module
|
|
340
|
+
client = get_uns_client()
|
|
341
|
+
values = client.last_value("raw/data/line-1/motor/main/temperature")
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
Use distinct names when the application needs clients for more than one UNS
|
|
345
|
+
OpenHub endpoint: `register_uns_client(url, name="secondary")` and
|
|
346
|
+
`get_uns_client("secondary")`.
|
|
347
|
+
|
|
330
348
|
If your service token comes from an environment variable or secret store, resolve it before constructing the client:
|
|
331
349
|
|
|
332
350
|
```python
|
|
@@ -341,6 +359,20 @@ client = UnsClient(
|
|
|
341
359
|
|
|
342
360
|
For larger service API and data-offer examples, use `configure-data-offer`. The scaffold uses `await register_api_catalog(...)` in `src/main.py`, while `src/api_routes.py` holds the `service_apis` and `data_offer_sources` definitions together with their handlers.
|
|
343
361
|
|
|
362
|
+
### Shared application state
|
|
363
|
+
|
|
364
|
+
`State` is a thread-safe, in-memory key/value store shared by every module in
|
|
365
|
+
one Python process. It is not persisted and starts empty after every restart.
|
|
366
|
+
|
|
367
|
+
```python
|
|
368
|
+
from uns_kit import State
|
|
369
|
+
|
|
370
|
+
state = State()
|
|
371
|
+
state.set("mark_machine", {"plateID": "P123"})
|
|
372
|
+
plate = state.get("mark_machine")
|
|
373
|
+
state.pop("mark_machine")
|
|
374
|
+
```
|
|
375
|
+
|
|
344
376
|
## Config placeholders (env + Infisical)
|
|
345
377
|
`uns-py` now resolves config placeholders in the same style as `uns-core`.
|
|
346
378
|
For Infisical placeholders, install the optional extra:
|
|
@@ -417,6 +449,8 @@ poetry install
|
|
|
417
449
|
poetry run python src/main.py
|
|
418
450
|
```
|
|
419
451
|
|
|
452
|
+
The generated `package.json` declares `unsDatahub.kind: "addon"` and controller compatibility so tagged releases can be discovered by UNS OpenHub controllers.
|
|
453
|
+
|
|
420
454
|
To add optional feature scaffolding later:
|
|
421
455
|
```bash
|
|
422
456
|
poetry run uns-kit-py configure-api .
|
|
@@ -424,6 +458,14 @@ poetry run uns-kit-py configure-cron .
|
|
|
424
458
|
poetry run uns-kit-py configure-data-offer .
|
|
425
459
|
```
|
|
426
460
|
|
|
461
|
+
For an existing Python project, add the current non-destructive package metadata defaults with:
|
|
462
|
+
|
|
463
|
+
```bash
|
|
464
|
+
poetry run uns-kit-py upgrade .
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
The command adds the UNS OpenHub add-on marker only when `unsDatahub` is absent and preserves existing metadata.
|
|
468
|
+
|
|
427
469
|
`configure-api` adds a service-API scaffold:
|
|
428
470
|
- `src/main.py`
|
|
429
471
|
- `src/api_routes.py`
|