kapps-semantic-middleware 0.2.0__tar.gz → 0.2.2__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.
- kapps_semantic_middleware-0.2.2/.env.example +15 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/.gitignore +5 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/AGENTS.md +55 -26
- kapps_semantic_middleware-0.2.2/CHANGELOG.md +848 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/CONTEXT-MAP.md +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/PKG-INFO +32 -20
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/README.md +29 -17
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/CONTEXT.md +22 -8
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/README.md +68 -31
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/__init__.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/__main__.py +19 -2
- kapps_semantic_middleware-0.2.2/demo/transferunits/algorithm.py +282 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/control_station.py +14 -46
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/controller.py +29 -349
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/index.py +16 -6
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/launcher.py +244 -38
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/middleware.py +41 -12
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/__main__.py +1 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/panel.py +3 -6
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/templates/panel.html +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/seed.py +6 -6
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/station_board.py +28 -188
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/templates/index.html +7 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/templates/station_board.html +16 -112
- kapps_semantic_middleware-0.2.2/demo/transferunits/watchdog.py +87 -0
- kapps_semantic_middleware-0.2.2/docs/mechanics/01-instantiation-and-lifecycle.md +90 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/02-workflow-registration.md +2 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/03-state-and-parameters.md +3 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/04-connector-binding.md +5 -10
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/05-operation-coordination.md +69 -31
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/06-views-and-projection.md +5 -3
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/07-writing-to-the-graph-and-to-devices.md +18 -18
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/mechanics/08-provisioning-and-seeding.md +32 -15
- kapps_semantic_middleware-0.2.2/docs/mechanics/09-the-state-dashboard.md +484 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/concepts.md +15 -3
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/conf.py +99 -6
- kapps_semantic_middleware-0.2.2/docs/site/errors.md +256 -0
- kapps_semantic_middleware-0.2.2/docs/site/guide/01-instantiation-and-lifecycle.md +95 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/02-workflow-registration.md +2 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/03-state-and-parameters.md +3 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/04-connector-binding.md +5 -10
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/05-operation-coordination.md +69 -31
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/06-views-and-projection.md +5 -3
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/07-writing-to-the-graph-and-to-devices.md +18 -18
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/08-provisioning-and-seeding.md +39 -15
- kapps_semantic_middleware-0.2.2/docs/site/guide/09-the-state-dashboard.md +309 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/guide/index.md +37 -23
- kapps_semantic_middleware-0.2.2/docs/site/index.md +4 -0
- kapps_semantic_middleware-0.2.2/docs/site/reference/activity.md +48 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/index.md +8 -3
- kapps_semantic_middleware-0.2.2/docs/site/reference/observation.md +11 -0
- kapps_semantic_middleware-0.2.2/docs/site/reference/possession.md +10 -0
- kapps_semantic_middleware-0.2.2/docs/site/reference/validation_report.md +10 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/requirements.txt +1 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/scenarios/factory.md +30 -32
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/CONTEXT.md +14 -3
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/demo_scenario1.ttl +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/docker/graphdb-repo-config.ttl +4 -4
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/scenario1_hello_world.ipynb +13 -13
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/scenario1_hello_world.py +16 -16
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/scenario2_door.ipynb +9 -9
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/scenario2_door.py +13 -13
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/seed.py +14 -14
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/pyproject.toml +24 -12
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/CONTEXT.md +67 -32
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/_deprecation.py +81 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/activity.py +23 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/commit.py +92 -33
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/connectors/__init__.py +1 -6
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/connectors/mqtt_binding.py +3 -3
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/connectors/rest_binding.py +90 -89
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/connectors/semantic.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/connectors/wiring.py +28 -19
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/credentials.py +203 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/dashboard.py +63 -17
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/dashboard_boxes.py +187 -34
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/dashboard_logs.py +455 -0
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/errors.py +157 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/examples_cli.py +43 -26
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/middleware.py +554 -320
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/observation.py +560 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/ontology/mes.ttl +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/ontology/service.ttl +3 -3
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/possession.py +549 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/projection.py +2 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/registration.py +389 -214
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/rest_router.py +59 -122
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/seeding.py +181 -0
- kapps_semantic_middleware-0.2.2/src/kapps_semantic_middleware/validation_report.py +434 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/vocabulary.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/README.md +34 -0
- kapps_semantic_middleware-0.2.2/tests/_browser.py +53 -0
- kapps_semantic_middleware-0.2.2/tests/_explicit.py +21 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/_hello_process.py +30 -8
- kapps_semantic_middleware-0.2.2/tests/_refusal_view.py +94 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/conftest.py +44 -24
- kapps_semantic_middleware-0.2.2/tests/reports/complete-without-releasing.nq +90 -0
- kapps_semantic_middleware-0.2.2/tests/reports/skip-reserve.nq +21 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_activity_feed.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_activity_feed_stop.py +9 -14
- kapps_semantic_middleware-0.2.2/tests/test_algorithm_loop.py +205 -0
- kapps_semantic_middleware-0.2.2/tests/test_capability_link.py +530 -0
- kapps_semantic_middleware-0.2.2/tests/test_children_take_the_fixture_dataset.py +89 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_commit_integration.py +54 -62
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_commit_unit.py +5 -5
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_controller_discovery.py +15 -15
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_controller_rebuild_view.py +22 -22
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_controller_view.py +71 -65
- kapps_semantic_middleware-0.2.2/tests/test_core_names_no_possession.py +209 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_create_integration.py +94 -97
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_create_unit.py +27 -9
- kapps_semantic_middleware-0.2.2/tests/test_credentials.py +300 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_dashboard.py +98 -11
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_dashboard_guard.py +57 -17
- kapps_semantic_middleware-0.2.2/tests/test_dashboard_logs.py +619 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_dashboard_name_integration.py +7 -7
- kapps_semantic_middleware-0.2.2/tests/test_dashboard_observation.py +262 -0
- kapps_semantic_middleware-0.2.2/tests/test_dashboard_tabs_in_a_browser.py +51 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_demo_activity_feed_wiring.py +5 -5
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_demo_broker_transport.py +50 -0
- kapps_semantic_middleware-0.2.2/tests/test_deregistration_names_by_iri.py +55 -0
- kapps_semantic_middleware-0.2.2/tests/test_docs_footer_from_license.py +65 -0
- kapps_semantic_middleware-0.2.2/tests/test_docs_landing_page.py +129 -0
- kapps_semantic_middleware-0.2.2/tests/test_error_actions.py +464 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_event_trigger_integration.py +46 -46
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_examples_cli.py +5 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_examples_serve_their_middlewares.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_factory_deregistration.py +20 -27
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_factory_smoke.py +232 -180
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_failure_dump_unit.py +2 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_favicon_routes.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_handover_integration.py +174 -138
- kapps_semantic_middleware-0.2.2/tests/test_heartbeat_phase.py +64 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_intake_integration.py +53 -53
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_issued_operation.py +318 -13
- kapps_semantic_middleware-0.2.2/tests/test_launcher_factory.py +1024 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_launcher_seeding.py +59 -47
- kapps_semantic_middleware-0.2.2/tests/test_liveness_integration.py +331 -0
- kapps_semantic_middleware-0.2.2/tests/test_liveness_loops.py +446 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_middleware_connector_flavours.py +11 -11
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_modes.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/test_multiline_records_in_a_browser.py +247 -0
- kapps_semantic_middleware-0.2.2/tests/test_names_no_consumer.py +91 -0
- kapps_semantic_middleware-0.2.2/tests/test_names_no_vendor.py +287 -0
- kapps_semantic_middleware-0.2.2/tests/test_no_deletion_of_individuals.py +52 -0
- kapps_semantic_middleware-0.2.2/tests/test_no_direct_writes.py +161 -0
- kapps_semantic_middleware-0.2.2/tests/test_no_pseudo_graph_in_queries.py +66 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_northbound_sync_integration.py +7 -7
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_notification_integration.py +27 -27
- kapps_semantic_middleware-0.2.2/tests/test_observation.py +544 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_optional_transport_stacks.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_pages_under_a_prefix.py +27 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_panel_convergence.py +1 -2
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_persistence_factory_warning.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/test_possession_handover.py +231 -0
- kapps_semantic_middleware-0.2.2/tests/test_public_errors.py +66 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_queue_durability_integration.py +26 -21
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_recursive_rest_router.py +132 -263
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_recursive_rest_router_integration.py +35 -34
- kapps_semantic_middleware-0.2.2/tests/test_refused_writes.py +399 -0
- kapps_semantic_middleware-0.2.2/tests/test_refused_writes_integration.py +335 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_request_claim_integration.py +86 -92
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_request_claim_unit.py +30 -9
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_reregistration.py +28 -18
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_rest_binding.py +45 -40
- kapps_semantic_middleware-0.2.2/tests/test_route_docstrings.py +187 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_scenario1_integration.py +16 -16
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_scenario2_integration.py +11 -11
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_scenario3_roundtrip_integration.py +15 -15
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_scenario3_seed_integration.py +24 -24
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_scenario3_wiring_integration.py +131 -39
- kapps_semantic_middleware-0.2.2/tests/test_seeding.py +217 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_semantic_connectors.py +1 -1
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_service_identity.py +58 -47
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_shape_from_typehints.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/test_shipped_ontologies_declare_their_classes.py +82 -0
- kapps_semantic_middleware-0.2.2/tests/test_shipped_stack_validates_shapes.py +393 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_southbound_echo_integration.py +15 -112
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_station_board_guard.py +113 -32
- kapps_semantic_middleware-0.2.2/tests/test_station_board_read_view.py +162 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_station_board_state_route.py +77 -119
- kapps_semantic_middleware-0.2.2/tests/test_stranded_operations.py +255 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_transfer_unit_plc.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/test_typed_identity.py +138 -0
- kapps_semantic_middleware-0.2.2/tests/test_validation_report.py +348 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_vocabulary.py +1 -1
- kapps_semantic_middleware-0.2.2/tests/test_writers_scope_covers_data.py +194 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/uv.lock +158 -9
- kapps_semantic_middleware-0.2.0/.env.example +0 -14
- kapps_semantic_middleware-0.2.0/CHANGELOG.md +0 -410
- kapps_semantic_middleware-0.2.0/demo/transferunits/algorithm.py +0 -391
- kapps_semantic_middleware-0.2.0/docs/mechanics/01-instantiation-and-lifecycle.md +0 -84
- kapps_semantic_middleware-0.2.0/docs/mechanics/09-the-state-dashboard.md +0 -236
- kapps_semantic_middleware-0.2.0/docs/site/guide/01-instantiation-and-lifecycle.md +0 -89
- kapps_semantic_middleware-0.2.0/docs/site/guide/09-the-state-dashboard.md +0 -175
- kapps_semantic_middleware-0.2.0/docs/site/index.md +0 -160
- kapps_semantic_middleware-0.2.0/docs/site/reference/activity.md +0 -9
- kapps_semantic_middleware-0.2.0/docs/site/reference/connectors/knowledge_graph_connector.md +0 -9
- kapps_semantic_middleware-0.2.0/src/kapps_semantic_middleware/connectors/knowledge_graph_connector.py +0 -133
- kapps_semantic_middleware-0.2.0/src/kapps_semantic_middleware/credentials.py +0 -91
- kapps_semantic_middleware-0.2.0/src/kapps_semantic_middleware/errors.py +0 -58
- kapps_semantic_middleware-0.2.0/src/kapps_semantic_middleware/possession.py +0 -186
- kapps_semantic_middleware-0.2.0/src/kapps_semantic_middleware/seeding.py +0 -110
- kapps_semantic_middleware-0.2.0/tests/test_algorithm_loop.py +0 -224
- kapps_semantic_middleware-0.2.0/tests/test_graphdb_credentials.py +0 -92
- kapps_semantic_middleware-0.2.0/tests/test_knowledge_graph_connector.py +0 -85
- kapps_semantic_middleware-0.2.0/tests/test_lap_measurement.py +0 -150
- kapps_semantic_middleware-0.2.0/tests/test_launcher_factory.py +0 -375
- kapps_semantic_middleware-0.2.0/tests/test_liveness_integration.py +0 -106
- kapps_semantic_middleware-0.2.0/tests/test_public_errors.py +0 -34
- kapps_semantic_middleware-0.2.0/tests/test_seeding.py +0 -62
- kapps_semantic_middleware-0.2.0/tests/test_station_board_set_route.py +0 -139
- kapps_semantic_middleware-0.2.0/tests/test_write_status.py +0 -301
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/.github/workflows/hygiene.yml +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/.github/workflows/publish.yml +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/.python-version +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/CLAUDE.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/LICENSE +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/__init__.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/factory.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/__init__.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/static/transferunit.svg +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/plc/transfer_unit.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/demo/transferunits/transferunit.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/_static/custom.css +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/_static/sfb-logo.png +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/_static/switcher.json +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/connectors/mqtt_binding.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/connectors/rest_binding.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/connectors/semantic.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/connectors/wiring.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/middleware.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/modes.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/projection.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/registration.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/rest_router.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/seeding.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/shacl_interop/shape_from_typehints.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/reference/vocabulary.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/docs/site/scenarios/index.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/__init__.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/demo_handover.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/demo_scenario2.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/docker/docker-compose.yml +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/handlers.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/examples/transferunit.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/scripts/release_checks.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/__init__.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/docs/mqtt-payloads.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/modes.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/ontology/core.ttl +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/operation.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/py.typed +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/shacl_interop/CONTEXT.md +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/shacl_interop/__init__.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/shacl_interop/shape_from_typehints.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/static/htmx-2.0.4.min.js +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/src/kapps_semantic_middleware/static/json-enc.js +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/_sse.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_generic_modules.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_intake.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_launcher_index_guard.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_launcher_index_links.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_notification_handler.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_notify.py +0 -0
- {kapps_semantic_middleware-0.2.0 → kapps_semantic_middleware-0.2.2}/tests/test_plc_guard.py +0 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# The triple store connection for examples and demo.
|
|
2
|
+
# The store runs with security disabled in the local Docker image, so username/password
|
|
3
|
+
# are placeholders that the client merely requires.
|
|
4
|
+
#
|
|
5
|
+
# Only these three variables are read. The examples and the demo name their own
|
|
6
|
+
# dataset in code -- kapps-demo, the one docker/docker-compose.yml creates -- and the
|
|
7
|
+
# test suite names its own. A TRIPLESTORE_DATASET left in your environment is ignored by
|
|
8
|
+
# all of them, because whatever they connect to, they wipe and re-seed.
|
|
9
|
+
#
|
|
10
|
+
# WARNING: point TRIPLESTORE_URL at a store you are allowed to overwrite. The dataset is
|
|
11
|
+
# pinned, but the server is not. A host that is neither loopback nor a bare container alias is
|
|
12
|
+
# refused unless TRIPLESTORE_ALLOW_DESTRUCTIVE=1 is set.
|
|
13
|
+
TRIPLESTORE_URL=http://localhost:7200
|
|
14
|
+
TRIPLESTORE_USERNAME=admin
|
|
15
|
+
TRIPLESTORE_PASSWORD=root
|
|
@@ -20,3 +20,8 @@ docs/site/_build/
|
|
|
20
20
|
# build output above.
|
|
21
21
|
docs/site/scenarios/hello-world.ipynb
|
|
22
22
|
docs/site/scenarios/door.ipynb
|
|
23
|
+
|
|
24
|
+
# Local agent output: the orchestrator's run logs per task, and scratch notes. A build's
|
|
25
|
+
# handoff and briefs under .claude/log/<ticket>/ stay trackable; only runs/ is machine output.
|
|
26
|
+
.claude/log/*/runs/
|
|
27
|
+
.scratch/
|
|
@@ -37,7 +37,7 @@ without forward references.
|
|
|
37
37
|
| [`docs/mechanics/06-views-and-projection.md`](docs/mechanics/06-views-and-projection.md) | Defining a ClassScope, what a view cannot select, what the northbound projection removes |
|
|
38
38
|
| [`docs/mechanics/07-writing-to-the-graph-and-to-devices.md`](docs/mechanics/07-writing-to-the-graph-and-to-devices.md) | Every path that causes a write, creating an instance and the predefined scopes, naming the field that moved, northbound vs. southbound, IRI handling |
|
|
39
39
|
| [`docs/mechanics/08-provisioning-and-seeding.md`](docs/mechanics/08-provisioning-and-seeding.md) | **Read first if `ogm=` is a mystery.** The bootstrap order, loading the shared ontologies, authoring the domain TBox, and seeding the instance data a Parameter needs |
|
|
40
|
-
| [`docs/mechanics/09-the-state-dashboard.md`](docs/mechanics/09-the-state-dashboard.md) | The
|
|
40
|
+
| [`docs/mechanics/09-the-state-dashboard.md`](docs/mechanics/09-the-state-dashboard.md) | The page an instance serves about itself, the box registry a subproject extends, hiding a box, posting to its own workflow, and the Logs tab with a logger's level set at run time |
|
|
41
41
|
|
|
42
42
|
### Where the reasoning lives
|
|
43
43
|
|
|
@@ -55,31 +55,37 @@ its three dependencies, by that dependency's own path. Use this table rather tha
|
|
|
55
55
|
| Name | Import from |
|
|
56
56
|
|---|---|
|
|
57
57
|
| `SemanticMiddleware`, `Mode` | `kapps_semantic_middleware` |
|
|
58
|
-
| `IRI`, `
|
|
58
|
+
| `IRI`, `TripleStore` | `kapps_triplestore_interface` |
|
|
59
59
|
| `OGM` | `kapps_ogm` |
|
|
60
60
|
| `ClassScope` | `kapps_ogm.utils.class_scope` |
|
|
61
61
|
| `SyncDirection` | `transitional_sync_middleware.middleware.sync.synced_connector` |
|
|
62
62
|
| `ConnectionInfo` | `transitional_sync_middleware.middleware.registries` |
|
|
63
63
|
| `INF` (the interface vocabulary) | `kapps_semantic_middleware.vocabulary` |
|
|
64
|
-
| `
|
|
64
|
+
| `triplestore_for`, `endpoint_for` | `kapps_semantic_middleware.credentials` |
|
|
65
65
|
| `enable_dashboard`, `panel`, `kv_table`, `hint`, `escape` | `kapps_semantic_middleware.dashboard` |
|
|
66
|
-
| `mw.commit()`, `mw.create()`, `mw.fetch()`, `mw.notify()`, `mw.on_notification()`, `mw.resource` (members of `SemanticMiddleware`, nothing more to import; `mw.create(cls, scope)` creates one new instance, `mw.resource` is the middleware's own Resource, `mw.notify(operation=op, resource=r)` sends a notification, an Operation's IRI with no payload and no write, and `mw.on_notification(handler, class_scope=...)` takes the notified Operations through the intake, one at a time, each as the Operation object, to the exposed workflow that realizes its Capability or else to the handler, with no lifecycle; the feedback of an Operation that the instance's Resource issued and that is no longer `queued` goes to the handler, also when a workflow of the instance realizes its Capability) | `kapps_semantic_middleware` |
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
66
|
+
| `mw.commit()`, `mw.create()`, `mw.fetch()`, `mw.notify()`, `mw.on_notification()`, `mw.resource` (members of `SemanticMiddleware`, nothing more to import; the keyword-only `verb` of `mw.commit()`, `"commit"` or `"handover"`, labels a refused write in `mw.refused_writes`; `mw.create(cls, scope)` creates one new instance, `mw.resource` is the middleware's own Resource, `mw.notify(operation=op, resource=r)` sends a notification, an Operation's IRI with no payload and no write, and `mw.on_notification(handler, class_scope=...)` takes the notified Operations through the intake, one at a time, each as the Operation object, to the exposed workflow that realizes its Capability or else to the handler, with no lifecycle; the feedback of an Operation that the instance's Resource issued and that is no longer `queued` goes to the handler, also when a workflow of the instance realizes its Capability) | `kapps_semantic_middleware` |
|
|
67
|
+
| `mw.refused_writes` (the writes of this instance that the store's shapes refused, newest first: each a `RefusedWrite` with its time, its verb, `commit`, `create` or `handover` (the possession extension's), its rules and the report; the newest 50, in memory only, and each logged once at INFO) | `kapps_semantic_middleware` |
|
|
68
|
+
| `mw.connections`, `mw.graph_binding` (what the instance has seen since it started, in memory only: one `ConnectionRecord` per wired connector, in the order of the wiring, with its state, last provide, consume, receive and sync, and last error; and the `GraphBindingRecord` of the store behind its OGM, with its last read, last write and last error. Each record carries the instance's resource and service IRI.) | `kapps_semantic_middleware` |
|
|
69
|
+
| `ConnectionRecord`, `GraphBindingRecord`, `CallError`, `is_connection_metadata` (the record types, and the one predicate that names the fields carrying connection metadata, such as an error's message.) | `kapps_semantic_middleware.observation` |
|
|
70
|
+
| `readable_results`, `validation_results`, `rule_names` (the store's validation report, the `report` of `ShaclValidationError`, read as RDF: each result for a person, as `ReadableResult`s of `Term`s with `short` and `full`; each result for comparing, as `ValidationResult`s with full IRIs; the rules for a log line), `RefusedWrite`, `render_refused_write` (one refused write as HTML: its first line, and an expander with the results and the whole report) | `kapps_semantic_middleware.validation_report` |
|
|
71
|
+
| `IssuedOperation` (what `mw.issue_operation()` yields: the draft of the new Operation in its block, with `op.data` and `op.update(instance_iri, data)`, which changes an existing instance in the Operation's commit, and after it the handle with `op.iri` and `op.issuer`, which waits with `await op.claimed(timeout=30)` and `await op.ended(timeout=None)`, or with their blocking twins `op.wait_claimed(timeout)` and `op.wait_ended(timeout)`) | `kapps_semantic_middleware.middleware` |
|
|
72
|
+
| `Create`, `Update` (the changes that a transition of `mw.commit()` is made of, and the `entry` of `possession.handover()`) | `kapps_ogm` |
|
|
69
73
|
| `Node` (the Operation object that the intake passes to a workflow or a notification handler; type a workflow's parameter with it) | `kapps_ogm` |
|
|
70
74
|
| `workpiece` (the scope of a new Workpiece for `mw.create()`: `workpiece(scope, possessor=mw.resource)`) | `kapps_semantic_middleware.possession` |
|
|
75
|
+
| `handover` (the change of possession, then the move: `with handover(mw, mode=MES.Pass, workpiece=workpiece, counterpart=peer, operation=op, entry=[...]):`, a context manager built on `mw.commit()`. `SemanticMiddleware.handover()` is its deprecated alias for one release.) | `kapps_semantic_middleware.possession` |
|
|
76
|
+
| `create_possession`, `switch_possession` (a workpiece's first possession, and a change of possession with no move, each in one `OGM.commit`, for a seed or a caller that holds no middleware), `find_possession_state`, `counterpart_has_complementary_ability` (the reads of a handover's preconditions), `mint_possession_state_iri` | `kapps_semantic_middleware.possession` |
|
|
71
77
|
| `operation` (the scope of a new Operation for `mw.create()`: `operation(scope, capability=cap)`) | `kapps_semantic_middleware.operation` |
|
|
72
78
|
| `PredefinedScope`, `ScopeChanges` (the hook through which a domain module brings its rules to `mw.create()`, and what its `changes()` returns) | `kapps_semantic_middleware.commit` |
|
|
73
79
|
| `SVC`, `OperationStatus` (the service vocabulary, and an Operation's status values) | `kapps_semantic_middleware.vocabulary` |
|
|
74
|
-
| `MES` (the handover abilities, such as `MES.Pass`, that `
|
|
75
|
-
| `HandoverPreconditionError`, `PossessionSwitchConflict`, `OperationQueueEmpty`, `OperationResolutionError`, `OntologyGroundTruthError`, `NotificationUndelivered` | `kapps_semantic_middleware.errors` |
|
|
76
|
-
| `ShaclValidationError` (the store refused a write by SHACL validation; `.report` is its validation report, verbatim), `
|
|
80
|
+
| `MES` (the handover abilities, such as `MES.Pass`, that `possession.handover()` takes as its `mode`) | `kapps_semantic_middleware.vocabulary` |
|
|
81
|
+
| `HandoverPreconditionError`, `PossessionSwitchConflict`, `OperationQueueEmpty`, `OperationResolutionError`, `OntologyGroundTruthError`, `NotificationUndelivered`; the types that tell the action: `OperationReceiverUnavailableError` and `NotificationReceiverUnavailableError` (Retry), `DeploymentError` with `DeploymentValueError` and `DeploymentRuntimeError`, `CapabilityNotRealizedError` and `NotificationReceiverAmbiguousError` (Repair) | `kapps_semantic_middleware.errors` |
|
|
82
|
+
| `ShaclValidationError` (the store refused a write by SHACL validation; `.report` is its validation report, verbatim), `TripleStoreResponseError` (any other error answer of the store; `ShaclValidationError` subclasses it), `PreconditionFailedError` (the store found the precondition of a write false and wrote nothing: a `Create` of an instance that it holds, or a value that a change replaces and that another write changed after the read), `TripleStoreInterfaceError` (any error of the interface) | `kapps_triplestore_interface.exceptions` |
|
|
77
83
|
| `AnonymousNodeFetchError`, `AmbiguousNodeAlignmentError`, `UnresolvableNodeAddressError` (each a `ValueError`) | `kapps_ogm.utils.errors` |
|
|
78
84
|
| `RequestException` (the store cannot be reached; `requests` is the store's HTTP client, reached through `kapps_triplestore_interface`, and not one of the three dependencies) | `requests.exceptions` |
|
|
79
85
|
|
|
80
86
|
Binding internals, if you are adding a protocol, live under
|
|
81
87
|
`kapps_semantic_middleware.connectors` — `semantic`, `mqtt_binding`, `rest_binding`,
|
|
82
|
-
`
|
|
88
|
+
`wiring`.
|
|
83
89
|
|
|
84
90
|
> `kapps_semantic_middleware/ontology/` is **not** a Python module. It is the directory holding the
|
|
85
91
|
> three vocabulary files (`core.ttl`, `mes.ttl`, `service.ttl`). Importing from it fails.
|
|
@@ -92,6 +98,13 @@ Each topic module is built on the generic core: `mw.commit()`, `mw.create()`, `m
|
|
|
92
98
|
kapps_ogm's changes. It never writes past them. A domain that is not modelled on Core uses the
|
|
93
99
|
generic modules and none of the cfc-specific ones.
|
|
94
100
|
|
|
101
|
+
Possession and the handover are such an extension, `kapps_semantic_middleware.possession`. The
|
|
102
|
+
core still knows Core's Capability, Resource and Operation (registration writes
|
|
103
|
+
`cfc:hasCapability`), but `middleware` and `registration` name no possession term and no `mes:`
|
|
104
|
+
handover ability, except two deprecated aliases that only delegate to the extension: the method
|
|
105
|
+
`SemanticMiddleware.handover()` and the `__getattr__` of `registration`, which resolves the old
|
|
106
|
+
names of the moved helpers and errors. `tests/test_core_names_no_possession.py` checks it.
|
|
107
|
+
|
|
95
108
|
Some generic modules still have cfc-specific parts inside. The table names those parts: the
|
|
96
109
|
functions, methods, classes and module-level names where a `cfc:` term may appear. Nowhere else in
|
|
97
110
|
such a module may one appear.
|
|
@@ -104,10 +117,10 @@ part listed with `cfc:` no longer has any.
|
|
|
104
117
|
| Module | Kind | What is cfc-specific in it |
|
|
105
118
|
|---|---|---|
|
|
106
119
|
| `kapps_semantic_middleware` | generic | |
|
|
120
|
+
| `kapps_semantic_middleware._deprecation` | generic | |
|
|
107
121
|
| `kapps_semantic_middleware.activity` | generic | |
|
|
108
122
|
| `kapps_semantic_middleware.commit` | generic | |
|
|
109
123
|
| `kapps_semantic_middleware.connectors` | generic | |
|
|
110
|
-
| `kapps_semantic_middleware.connectors.knowledge_graph_connector` | generic | |
|
|
111
124
|
| `kapps_semantic_middleware.connectors.mqtt_binding` | generic | |
|
|
112
125
|
| `kapps_semantic_middleware.connectors.rest_binding` | generic | |
|
|
113
126
|
| `kapps_semantic_middleware.connectors.semantic` | generic | |
|
|
@@ -115,17 +128,20 @@ part listed with `cfc:` no longer has any.
|
|
|
115
128
|
| `kapps_semantic_middleware.credentials` | generic | |
|
|
116
129
|
| `kapps_semantic_middleware.dashboard` | generic | |
|
|
117
130
|
| `kapps_semantic_middleware.dashboard_boxes` | generic | |
|
|
131
|
+
| `kapps_semantic_middleware.dashboard_logs` | generic | |
|
|
118
132
|
| `kapps_semantic_middleware.errors` | generic | |
|
|
119
133
|
| `kapps_semantic_middleware.examples_cli` | generic | |
|
|
120
134
|
| `kapps_semantic_middleware.modes` | generic | |
|
|
135
|
+
| `kapps_semantic_middleware.observation` | generic | |
|
|
121
136
|
| `kapps_semantic_middleware.projection` | generic | |
|
|
122
137
|
| `kapps_semantic_middleware.rest_router` | generic | |
|
|
123
138
|
| `kapps_semantic_middleware.shacl_interop` | generic | |
|
|
124
139
|
| `kapps_semantic_middleware.shacl_interop.shape_from_typehints` | generic | |
|
|
125
|
-
| `kapps_semantic_middleware.
|
|
140
|
+
| `kapps_semantic_middleware.validation_report` | generic | |
|
|
141
|
+
| `kapps_semantic_middleware.possession` | cfc-specific | Possession, an extension built on the generic core: one possession state per Resource, the `handover()` with its preconditions and its change of possession, the `workpiece` scope, and the possession helpers that a seed uses |
|
|
126
142
|
| `kapps_semantic_middleware.operation` | cfc-specific | The Operation: its link to the Capability that it implements, the `operation` scope, and the scope and the Capabilities of a received Operation |
|
|
127
|
-
| `kapps_semantic_middleware.middleware` | generic, with cfc-specific parts | `SemanticMiddleware.handover`, `SemanticMiddleware.
|
|
128
|
-
| `kapps_semantic_middleware.registration` | generic, with cfc-specific parts | `register_workflow`, `register_state_property`, `create_operation`, `_resolve_claim`, `find_resource_operations`, `
|
|
143
|
+
| `kapps_semantic_middleware.middleware` | generic, with cfc-specific parts | `SemanticMiddleware.handover`, `SemanticMiddleware.issue_operation`, `SemanticMiddleware._read_received`: the deprecated alias of the possession extension's handover, which calls it, the Operation of a request, created under the operation scope, and the intake's read of a received Operation with the Capabilities it implements |
|
|
144
|
+
| `kapps_semantic_middleware.registration` | generic, with cfc-specific parts | `register_workflow`, `register_state_property`, `_register_capability`, `create_operation`, `_resolve_claim`, `find_resource_operations`, `find_stranded_operations`: the Capability links of registration and dispatch (the resource's link is one OGM append, in the commit that writes the Capability) |
|
|
129
145
|
| `kapps_semantic_middleware.seeding` | generic, with cfc-specific parts | `CORE_GRAPH`: the graph into which the shared ontologies load Core |
|
|
130
146
|
| `kapps_semantic_middleware.vocabulary` | generic, with cfc-specific parts | `CORE_NS`, `CORE_ONTOLOGY`, `CFC`: the one home of every IRI holds Core's terms too |
|
|
131
147
|
|
|
@@ -136,14 +152,16 @@ the package's API, and is not classified.
|
|
|
136
152
|
|
|
137
153
|
### These fail silently
|
|
138
154
|
|
|
139
|
-
**`
|
|
140
|
-
connects to.** `seeding.
|
|
141
|
-
|
|
142
|
-
written months ago — silently redirects a wipe. Nothing validates that the
|
|
143
|
-
meant; it only has to exist. Use `credentials.
|
|
155
|
+
**`TripleStoreEndpoint.from_env()` connects to whatever `TRIPLESTORE_DATASET` names, and seeding
|
|
156
|
+
destroys what it connects to.** `seeding.clear_dataset` clears the default graph of the store's
|
|
157
|
+
dataset, so a value left over in a shell — from another project, another checkout, a `.bashrc`
|
|
158
|
+
written months ago — silently redirects a wipe. Nothing validates that the dataset was the one you
|
|
159
|
+
meant; it only has to exist. Use `credentials.triplestore_for("name")`, which names the dataset in
|
|
144
160
|
code and ignores the variable, for anything that seeds, clears, or re-seeds. Note this hazard belongs
|
|
145
|
-
to the *variable*, not the server: pinning the
|
|
146
|
-
shared instance.
|
|
161
|
+
to the *variable*, not the server: pinning the dataset does not stop `TRIPLESTORE_URL` pointing at a
|
|
162
|
+
shared instance. `seeding` guards the server too: `clear_dataset` and `load_shared_ontologies(reload=True)`
|
|
163
|
+
raise `DeploymentValueError` for a host that is neither loopback nor a bare container alias, unless
|
|
164
|
+
`TRIPLESTORE_ALLOW_DESTRUCTIVE=1` is set.
|
|
147
165
|
|
|
148
166
|
**A `ClassScope` terminates at a Parameter and cannot select within one.** Any chain element below
|
|
149
167
|
a complex property is silently discarded during fetch. A view that tries to reach inside a
|
|
@@ -202,6 +220,15 @@ goes to the proxy's own root, and the form posts to nothing, with no error on th
|
|
|
202
220
|
path relative to the page, `workflows/<name>/execute`, as the library's own pages do. See
|
|
203
221
|
[`docs/mechanics/09-the-state-dashboard.md`](docs/mechanics/09-the-state-dashboard.md).
|
|
204
222
|
|
|
223
|
+
**The dashboard shows connection metadata unless it is told not to.** `enable_dashboard(mw)` makes
|
|
224
|
+
a development page: it shows each parameter's MQTT topic, the protocol properties the projection
|
|
225
|
+
stripped, and the message of a connection's or the graph binding's last error, which may name a
|
|
226
|
+
host, a port or a URL. That is on purpose: the page is the instance's own diagnostic surface for
|
|
227
|
+
laboratory deployments, not the northbound payload that other machines read. A deployment that is
|
|
228
|
+
not a laboratory one passes `dev=False`, or it prints topics and addresses on an HTTP port. The log
|
|
229
|
+
keeps an MQTT topic at DEBUG either way; that the page and the log differ is deliberate. See
|
|
230
|
+
[`docs/mechanics/09-the-state-dashboard.md`](docs/mechanics/09-the-state-dashboard.md).
|
|
231
|
+
|
|
205
232
|
### These fail loudly
|
|
206
233
|
|
|
207
234
|
**Every class you register against must already exist in the ontology.** The middleware creates
|
|
@@ -210,9 +237,11 @@ instances automatically but never mints classes. A domain-specific subclass of `
|
|
|
210
237
|
all pre-exist. Startup fails immediately, naming the missing class.
|
|
211
238
|
|
|
212
239
|
**All knowledge-graph writes go through the OGM.** Raw SPARQL `UPDATE` or direct
|
|
213
|
-
`kapps_triplestore_interface` mutation calls bypass the validated write path
|
|
214
|
-
|
|
215
|
-
|
|
240
|
+
`kapps_triplestore_interface` mutation calls bypass the validated write path: they skip the OGM's checks and its atomicity, so a property
|
|
241
|
+
replacement is not one update. The store still validates every update against its shapes. Reads may use the access module directly; only writes are constrained. The resource's
|
|
242
|
+
link to each Capability it provides is one `Append` in an OGM commit, which keeps the other links,
|
|
243
|
+
so instances that register on one resource at the same moment keep every link. Only seeding, which
|
|
244
|
+
provisions a dataset before any service runs, writes to the store directly.
|
|
216
245
|
|
|
217
246
|
**`@mw.workflow` and `@mw.state` are resource-mode only.** Each raises `RuntimeError` when called
|
|
218
247
|
on an instance in any other mode, and `ValueError` when a required class IRI is missing.
|
|
@@ -220,7 +249,7 @@ on an instance in any other mode, and `ValueError` when a required class IRI is
|
|
|
220
249
|
### Structural facts
|
|
221
250
|
|
|
222
251
|
**Build against `src/kapps_semantic_middleware/`. `examples/` and `demo/` are illustrations, not
|
|
223
|
-
API.** They are teaching vehicles seeded against throwaway
|
|
252
|
+
API.** They are teaching vehicles seeded against throwaway datasets, not production patterns to
|
|
224
253
|
copy.
|
|
225
254
|
|
|
226
255
|
**The demo imports as `kapps_semantic_middleware.demonstrations`, not `demo`.** The wheel remaps
|
|
@@ -237,4 +266,4 @@ Resource; select by address or by advertised capability rather than assuming exa
|
|
|
237
266
|
is a resource-mode instance with its own Resource, not a server-mode one.
|
|
238
267
|
|
|
239
268
|
**Docker is a prerequisite for running the examples, never for using the library.** The bundled
|
|
240
|
-
`docker compose` file provides the
|
|
269
|
+
`docker compose` file provides the triple store the scenarios and the factory need.
|