intersect-sdk 0.7.0__tar.gz → 0.8.1__tar.gz

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: intersect-sdk
-Version: 0.7.0
+Version: 0.8.1
 Summary: Python SDK to interact with INTERSECT
 Keywords: intersect
 Author-Email: Lance Drane <dranelt@ornl.gov>, Marshall McDonnell <mcdonnellmt@ornl.gov>, Seth Hitefield <hitefieldsd@ornl.gov>, Andrew Ayres <ayresaf@ornl.gov>, Gregory Cage <cagege@ornl.gov>, Jesse McGaha <mcgahajr@ornl.gov>, Robert Smith <smithrw@ornl.gov>, Gavin Wiggins <wigginsg@ornl.gov>, Michael Brim <brimmj@ornl.gov>, Rick Archibald <archibaldrk@ornl.gov>, Addi Malviya Thakur <malviyaa@ornl.gov>
@@ -10,6 +10,10 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Project-URL: Homepage, https://github.com/INTERSECT-SDK/python-sdk/
+Project-URL: Changelog, https://github.com/INTERSECT-SDK/python-sdk/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://intersect-python-sdk.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/INTERSECT-SDK/python-sdk/issues
 Requires-Python: <4.0,>=3.8.10
 Requires-Dist: pydantic>=2.7.0
 Requires-Dist: retrying<2.0.0,>=1.3.4
@@ -17,13 +21,15 @@ Requires-Dist: paho-mqtt<2.0.0,>=1.6.1
 Requires-Dist: minio>=7.2.3
 Requires-Dist: jsonschema[format-nongpl]>=4.21.1
 Requires-Dist: eval-type-backport>=0.1.3; python_version < "3.10"
+Provides-Extra: amqp
 Requires-Dist: pika<2.0.0,>=1.3.2; extra == "amqp"
+Provides-Extra: docs
 Requires-Dist: sphinx>=5.3.0; extra == "docs"
 Requires-Dist: furo>=2023.3.27; extra == "docs"
-Provides-Extra: amqp
-Provides-Extra: docs
 Description-Content-Type: text/markdown
 
+[![Static Badge](https://img.shields.io/badge/DOI-10.11578%2Fdc.20240927.1-blue)](https://doi.org/10.11578/dc.20240927.1)
+
 # INTERSECT-SDK
 
 The INTERSECT-SDK is a framework for microservices to integrate themselves into the wider Interconnected Science Ecosystem (INTERSECT).
@@ -33,6 +39,8 @@ Please note that this README is currently a work in progress.
 ## What is INTERSECT?
 [INTERSECT](https://www.ornl.gov/intersect) was designed as a specific usecase - as an open federated hardware/software architecture for the laboratory of the future, which connects scientific instruments, robot-controlled laboratories and edge/center computing/data resources to enable autonomous experiments, self-driving laboratories, smart manufacturing, and AI-driven design, discovery and evaluation.
 
+For a high-level overview, please see [the architecture website.](https://intersect-architecture.readthedocs.io/en/latest/)
+
 ## What are the core design philosophies of the SDK?
 
 - Event-driven architecture

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/README.md

@@ -1,3 +1,5 @@
+[![Static Badge](https://img.shields.io/badge/DOI-10.11578%2Fdc.20240927.1-blue)](https://doi.org/10.11578/dc.20240927.1)
+
 # INTERSECT-SDK
 
 The INTERSECT-SDK is a framework for microservices to integrate themselves into the wider Interconnected Science Ecosystem (INTERSECT).
@@ -7,6 +9,8 @@ Please note that this README is currently a work in progress.
 ## What is INTERSECT?
 [INTERSECT](https://www.ornl.gov/intersect) was designed as a specific usecase - as an open federated hardware/software architecture for the laboratory of the future, which connects scientific instruments, robot-controlled laboratories and edge/center computing/data resources to enable autonomous experiments, self-driving laboratories, smart manufacturing, and AI-driven design, discovery and evaluation.
 
+For a high-level overview, please see [the architecture website.](https://intersect-architecture.readthedocs.io/en/latest/)
+
 ## What are the core design philosophies of the SDK?
 
 - Event-driven architecture

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/pyproject.toml

@@ -35,11 +35,17 @@ dependencies = [
     "jsonschema[format-nongpl]>=4.21.1",
     "eval-type-backport>=0.1.3;python_version<'3.10'",
 ]
-version = "0.7.0"
+version = "0.8.1"
 
 [project.license]
 text = "BSD-3-Clause"
 
+[project.urls]
+Homepage = "https://github.com/INTERSECT-SDK/python-sdk/"
+Changelog = "https://github.com/INTERSECT-SDK/python-sdk/blob/main/CHANGELOG.md"
+Documentation = "https://intersect-python-sdk.readthedocs.io/en/latest/"
+Issues = "https://github.com/INTERSECT-SDK/python-sdk/issues"
+
 [project.optional-dependencies]
 amqp = [
     "pika>=1.3.2,<2.0.0",
@@ -49,42 +55,6 @@ docs = [
     "furo>=2023.3.27",
 ]
 
-[tool.pdm.dev-dependencies]
-lint = [
-    "pre-commit>=3.3.1",
-    "ruff>=0.4.2",
-    "mypy>=1.10.0",
-    "types-paho-mqtt>=1.6.0.20240106",
-]
-test = [
-    "pytest>=7.3.2",
-    "pytest-cov>=4.1.0",
-    "httpretty>=1.1.4",
-]
-
-[tool.pdm.scripts]
-test-all = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
-test-all-debug = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml -s"
-test-unit = "pytest tests/unit --cov=src/intersect_sdk/"
-test-e2e = "pytest tests/e2e --cov=src/intersect_sdk/"
-lint-format = "ruff format"
-lint-ruff = "ruff check --fix"
-lint-mypy = "mypy src/intersect_sdk/"
-
-[tool.pdm.scripts.lint]
-composite = [
-    "lint-format",
-    "lint-ruff",
-    "lint-mypy",
-]
-
-[tool.pdm.build]
-package-dir = "src"
-
-[tool.pdm.version]
-source = "file"
-path = "src/intersect_sdk/version.py"
-
 [tool.ruff]
 line-length = 100
 
@@ -138,8 +108,6 @@ ignore = [
     "COM812",
     "ISC001",
     "SIM105",
-    "ANN101",
-    "ANN102",
     "ANN401",
     "PLR2004",
 ]
@@ -214,13 +182,62 @@ addopts = "-ra"
 [tool.coverage.report]
 omit = [
     "*__init__*",
+    "*/discovery_service.py",
 ]
 exclude_also = [
     "pragma: no-cover",
     "if (typing\\\\.)?TYPE_CHECKING:",
     "@(abc\\\\.)?abstractmethod",
+    "class .*\\bProtocol\\):",
+    "raise NotImplementedError",
+    "except.* ImportError",
 ]
 
+[tool.pdm.dev-dependencies]
+lint = [
+    "pre-commit>=3.3.1",
+    "ruff==0.9.4",
+    "mypy>=1.10.0",
+    "types-paho-mqtt>=1.6.0.20240106",
+    "codespell>=2.3.0",
+]
+test = [
+    "pytest>=7.3.2",
+    "pytest-cov>=4.1.0",
+    "httpretty>=1.1.4",
+]
+
+[tool.pdm.scripts]
+test-all = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
+test-all-debug = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml -s"
+test-unit = "pytest tests/unit --cov=src/intersect_sdk/"
+test-e2e = "pytest tests/e2e --cov=src/intersect_sdk/"
+lint-docs = "sphinx-build -W --keep-going docs docs/_build"
+lint-format = "ruff format"
+lint-ruff = "ruff check --fix"
+lint-mypy = "mypy src/intersect_sdk/"
+lint-spelling = "codespell -w docs examples src tests *.md -S docs/_build"
+
+[tool.pdm.scripts.lint]
+composite = [
+    "lint-format",
+    "lint-ruff",
+    "lint-mypy",
+    "lint-spelling",
+    "lint-docs",
+]
+
+[tool.pdm.build]
+package-dir = "src"
+
+[tool.pdm.version]
+source = "file"
+path = "src/intersect_sdk/version.py"
+
+[tool.codespell]
+skip = ".git*,*.lock,.venv,.*cache/*,./docs/_build/*"
+check-hidden = true
+
 [build-system]
 requires = [
     "pdm-backend",

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/__init__.py

@@ -19,12 +19,13 @@ from .config.client import IntersectClientConfig
 from .config.service import IntersectServiceConfig
 from .config.shared import (
     ControlPlaneConfig,
+    ControlProvider,
     DataStoreConfig,
     DataStoreConfigMap,
     HierarchyConfig,
 )
 from .core_definitions import IntersectDataHandler, IntersectMimeType
-from .schema import get_schema_from_capability_implementation
+from .schema import get_schema_from_capability_implementations
 from .service import IntersectService
 from .service_callback_definitions import (
     INTERSECT_SERVICE_RESPONSE_CALLBACK_TYPE,
@@ -42,30 +43,31 @@ from .shared_callback_definitions import (
 from .version import __version__, version_info, version_string
 
 __all__ = [
-    'IntersectDataHandler',
-    'IntersectEventDefinition',
-    'IntersectMimeType',
-    'intersect_event',
-    'intersect_message',
-    'intersect_status',
-    'get_schema_from_capability_implementation',
-    'IntersectService',
-    'IntersectClient',
-    'IntersectClientCallback',
-    'IntersectDirectMessageParams',
-    'INTERSECT_CLIENT_RESPONSE_CALLBACK_TYPE',
     'INTERSECT_CLIENT_EVENT_CALLBACK_TYPE',
+    'INTERSECT_CLIENT_RESPONSE_CALLBACK_TYPE',
     'INTERSECT_JSON_VALUE',
     'INTERSECT_SERVICE_RESPONSE_CALLBACK_TYPE',
-    'IntersectBaseCapabilityImplementation',
-    'default_intersect_lifecycle_loop',
-    'IntersectClientConfig',
-    'IntersectServiceConfig',
-    'HierarchyConfig',
     'ControlPlaneConfig',
+    'ControlProvider',
     'DataStoreConfig',
     'DataStoreConfigMap',
+    'HierarchyConfig',
+    'IntersectBaseCapabilityImplementation',
+    'IntersectClient',
+    'IntersectClientCallback',
+    'IntersectClientConfig',
+    'IntersectDataHandler',
+    'IntersectDirectMessageParams',
+    'IntersectEventDefinition',
+    'IntersectMimeType',
+    'IntersectService',
+    'IntersectServiceConfig',
     '__version__',
+    'default_intersect_lifecycle_loop',
+    'get_schema_from_capability_implementations',
+    'intersect_event',
+    'intersect_message',
+    'intersect_status',
     'version_info',
     'version_string',
 ]

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/control_plane/brokers/amqp_client.py

@@ -254,7 +254,7 @@ class AMQPClient(BrokerClient):
         if self._should_disconnect:
             connection.ioloop.stop()
         else:
-            logger.warn('Connection closed, reopening in 5 seconds: %s', reason)
+            logger.warning('Connection closed, reopening in 5 seconds: %s', reason)
             connection.ioloop.call_later(5, connection.ioloop.stop)
         self._channel_flags.unset_all()
         self._channel_out = None

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/control_plane/brokers/mqtt_client.py

@@ -113,7 +113,7 @@ class MQTTClient(BrokerClient):
             topic: The topic on which to publish the message as a string.
             payload: The message to publish, as raw bytes.
             persist: Determine if the message should live until queue consumers or available (True), or
-              if it should be removed immediatedly (False)
+              if it should be removed immediately (False)
         """
         # NOTE: RabbitMQ only works with QOS of 1 and 0, and seems to convert QOS2 to QOS1
         self._connection.publish(topic, payload, qos=2 if persist else 0)

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/control_plane/control_plane_manager.py

@@ -66,7 +66,7 @@ class ControlPlaneManager:
         """
         if control_configs == 'discovery':
             msg = 'Discovery service not implemented yet'
-            raise ValueError(msg)
+            raise NotImplementedError(msg)
         self._control_providers = [
             create_control_provider(config, self.get_subscription_channels)
             for config in control_configs

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/data_plane/data_plane_manager.py

@@ -32,7 +32,7 @@ class DataPlaneManager:
 
         # warn users about missing data plane
         if not self._minio_providers:
-            logger.warn('WARNING: This service cannot support any MINIO instances')
+            logger.warning('WARNING: This service cannot support any MINIO instances')
 
     def incoming_message_data_handler(self, message: UserspaceMessage | EventMessage) -> bytes:
         """Get data from the request data provider.

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/event_metadata.py

@@ -42,7 +42,7 @@ def definition_metadata_differences(
 ) -> list[tuple[str, str, str]]:
     """Return a list of differences between 'definition' and 'metadata'.
 
-    First tuple value = defintion key
+    First tuple value = definition key
     Second tuple value = second value
     Third tuple value = already cached value
     """

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/interfaces.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
-from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Protocol
 
 if TYPE_CHECKING:
     from uuid import UUID
 
+    from ..client_callback_definitions import INTERSECT_CLIENT_EVENT_CALLBACK_TYPE
+    from ..config.shared import HierarchyConfig
     from ..service_callback_definitions import (
         INTERSECT_SERVICE_RESPONSE_CALLBACK_TYPE,
     )
@@ -14,13 +15,12 @@ if TYPE_CHECKING:
     )
 
 
-class IntersectEventObserver(ABC):
+class IntersectEventObserver(Protocol):
     """Abstract definition of an entity which observes an INTERSECT event (i.e. IntersectService).
 
     Used as the common interface for event emitters (i.e. CapabilityImplementations).
     """
 
-    @abstractmethod
     def _on_observe_event(self, event_name: str, event_value: Any, operation: str) -> None:
         """How to react to an event being fired.
 
@@ -31,19 +31,35 @@ class IntersectEventObserver(ABC):
         """
         ...
 
-    @abstractmethod
     def create_external_request(
         self,
         request: IntersectDirectMessageParams,
         response_handler: INTERSECT_SERVICE_RESPONSE_CALLBACK_TYPE | None = None,
+        timeout: float = 300.0,
     ) -> UUID:
-        """Observed entity (capabilitiy) tells observer (i.e. service) to send an external request.
+        """Observed entity (capability) tells observer (i.e. service) to send an external request.
 
         Params:
-          - request: the request we want to send out, encapsulated as an IntersectClientMessageParams object
+          - request: the request we want to send out, encapsulated as an IntersectDirectMessageParams object
           - response_handler: optional callback for how we want to handle the response from this request.
+          - timeout: optional value for how long we should wait on the request, in seconds (default: 300 seconds)
 
         Returns:
           - generated RequestID associated with your request
         """
         ...
+
+    def register_event(
+        self,
+        service: HierarchyConfig,
+        event_name: str,
+        response_handler: INTERSECT_CLIENT_EVENT_CALLBACK_TYPE,
+    ) -> None:
+        """Observed entity (capability) tells observer (i.e. service) to subscribe to a specific event.
+
+        Params:
+          - service: HierarchyConfig of the service we want to talk to
+          - event_name: name of event to subscribe to
+          - response_handler: callback for how to handle the reception of an event
+        """
+        ...

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/messages/userspace.py

@@ -25,13 +25,13 @@ from typing import Any, Union
 from pydantic import AwareDatetime, Field, TypeAdapter
 from typing_extensions import Annotated, TypedDict
 
-from ...constants import SYSTEM_OF_SYSTEM_REGEX  # noqa: TCH001 (this is runtime checked)
-from ...core_definitions import (  # noqa: TCH001 (this is runtime checked)
+from ...constants import SYSTEM_OF_SYSTEM_REGEX
+from ...core_definitions import (
     IntersectDataHandler,
     IntersectMimeType,
 )
 from ...version import version_string
-from ..data_plane.minio_utils import MinioPayload  # noqa: TCH001 (this is runtime checked)
+from ..data_plane.minio_utils import MinioPayload  # noqa: TC001 (this is runtime checked)
 
 
 class UserspaceMessageHeader(TypedDict):

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/_internal/schema.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import inspect
+import re
 from enum import Enum
 from typing import (
     TYPE_CHECKING,
@@ -55,6 +56,9 @@ For networking types, https://docs.pydantic.dev/latest/api/networks/
 For a complete reference, https://docs.pydantic.dev/latest/concepts/conversion_table
 """
 
+CAPABILITY_NAME_PATTERN = r'[\w-]+'
+"""Regular expression we use to check valid capability names. Since capability namespacing only occurs in services, we can be more lax than for how we name services/systems/etc. """
+
 
 class _FunctionAnalysisResult(NamedTuple):
     """private class generated from static analysis of function."""
@@ -302,7 +306,7 @@ def _add_events(
 
 
 def _introspection_baseline(
-    capability: IntersectBaseCapabilityImplementation,
+    capability: type[IntersectBaseCapabilityImplementation],
     excluded_data_handlers: set[IntersectDataHandler],
 ) -> tuple[
     dict[Any, Any],  # $defs for schemas (common)
@@ -332,8 +336,9 @@ def _introspection_baseline(
     function_map = {}
     event_metadatas: dict[str, EventMetadata] = {}
 
-    cap_name = capability.capability_name
-    status_func, response_funcs, event_funcs = _get_functions(type(capability))
+    # capability_name should have already been checked before calling this function
+    cap_name = capability.intersect_sdk_capability_name
+    status_func, response_funcs, event_funcs = _get_functions(capability)
 
     # parse functions
     for class_name, name, method, min_params in response_funcs:
@@ -439,7 +444,7 @@ def _introspection_baseline(
 
         # final function mapping
         function_map[public_name] = FunctionMetadata(
-            type(capability),
+            capability,
             method,
             function_cache_request_adapter,
             function_cache_response_adapter,
@@ -477,7 +482,7 @@ def _introspection_baseline(
     if status_fn_type_adapter and status_fn and status_fn_name:
         public_status_name = f'{cap_name}.{status_fn_name}'
         function_map[public_status_name] = FunctionMetadata(
-            type(capability),
+            capability,
             status_fn,
             None,
             status_fn_type_adapter,
@@ -494,52 +499,78 @@ def _introspection_baseline(
 
 
 def get_schema_and_functions_from_capability_implementations(
-    capabilities: list[IntersectBaseCapabilityImplementation],
+    capabilities: list[type[IntersectBaseCapabilityImplementation]],
     service_name: HierarchyConfig,
     excluded_data_handlers: set[IntersectDataHandler],
 ) -> tuple[
     dict[str, Any],
     dict[str, FunctionMetadata],
     dict[str, EventMetadata],
-    IntersectBaseCapabilityImplementation | None,
+    type[IntersectBaseCapabilityImplementation] | None,
     str | None,
     TypeAdapter[Any] | None,
 ]:
     """This function generates the core AsyncAPI schema, and the core mappings which are derived from the schema.
 
+    Importantly, this function needs to be able to work with static classes, and not instances. This is because users
+    should be free to define their constructor as they wish, with any arbitrary parameters. Users should also be allowed
+    to execute whatever code they'd like in their constructor, such as establishing remote connections. At the same time,
+    we want to allow users to quickly generate an INTERSECT schema, without having to worry about any dependencies from their constructor code.
+
     In-depth introspection is handled later on.
     """
-    capability_type_docs: str = ''
-    status_function_cap: IntersectBaseCapabilityImplementation | None = None
+    status_function_cap: type[IntersectBaseCapabilityImplementation] | None = None
     status_function_name: str | None = None
     status_function_schema: dict[str, Any] | None = None
     status_function_adapter: TypeAdapter[Any] | None = None
-    schemas: dict[Any, Any] = {}
-    channels: dict[str, dict[str, dict[str, Any]]] = {}  # endpoint schemas
+    shared_schemas: dict[Any, Any] = {}  # "shared" schemas which get put in $defs
+    capability_schemas: dict[str, Any] = {}  # endpoint schemas
     function_map: dict[str, FunctionMetadata] = {}  # endpoint functionality
-    events: dict[str, Any] = {}  # event schemas
+    events: dict[
+        str, Any
+    ] = {}  # event schemas - TODO event names are currently "global" across capabilities, may want to change this?
     event_map: dict[str, EventMetadata] = {}  # event functionality
-    for capability in capabilities:
-        capability_type: type[IntersectBaseCapabilityImplementation] = type(capability)
-        if capability_type.__doc__:
-            capability_type_docs += inspect.cleandoc(capability_type.__doc__) + '\n'
+    for capability_type in capabilities:
+        cap_name = capability_type.intersect_sdk_capability_name
+        if (
+            not cap_name
+            or not isinstance(cap_name, str)
+            or not re.fullmatch(CAPABILITY_NAME_PATTERN, cap_name)
+        ):
+            die(
+                f'Invalid intersect_sdk_capability_name on capability {capability_type.__name__} - must be a non-empty string with only alphanumeric characters and hyphens (you must explicitly set this, and do so on the class and not an instance).'
+            )
+        if cap_name in capability_schemas:
+            die(
+                f'Invalid intersect_sdk_capability_name on capability {capability_type.__name__} - value "{cap_name}" is a duplicate and has already appeared in another capability.'
+            )
+
         (
-            cap_schemas,
+            subschemas,
             (cap_status_fn_name, cap_status_schema, cap_status_type_adapter),
-            cap_channels,
+            cap_functions,
             cap_function_map,
             cap_events,
             cap_event_map,
-        ) = _introspection_baseline(capability, excluded_data_handlers)
+        ) = _introspection_baseline(capability_type, excluded_data_handlers)
 
         if cap_status_fn_name and cap_status_schema and cap_status_type_adapter:
-            status_function_cap = capability
+            if status_function_name is not None:
+                # TODO may want to change this later
+                die('Only one capability may have an @intersect_status function')
+            status_function_cap = capability_type
             status_function_name = cap_status_fn_name
             status_function_schema = cap_status_schema
             status_function_adapter = cap_status_type_adapter
 
-        schemas.update(cap_schemas)
-        channels.update(cap_channels)
+        shared_schemas.update(subschemas)
+        # NOTE: we will still add the capability to the schema, even if there are no @intersect_message annotations
+        capability_schemas[cap_name] = {
+            'channels': cap_functions,
+        }
+        # add documentation for the capabilities
+        if capability_type.__doc__:
+            capability_schemas[cap_name]['description'] = inspect.cleandoc(capability_type.__doc__)
         function_map.update(cap_function_map)
         events.update(cap_events)
         event_map.update(cap_event_map)
@@ -549,15 +580,17 @@ def get_schema_and_functions_from_capability_implementations(
         'x-intersect-version': version_string,
         'info': {
             'title': service_name.hierarchy_string('.'),
+            'description': 'INTERSECT schema',
             'version': '0.0.0',  # NOTE: this will be modified by INTERSECT CORE, users do not manage their schema versions
         },
         # applies to how an incoming message payload will be parsed.
         # can be changed per channel
         'defaultContentType': 'application/json',
-        'channels': channels,
+        'capabilities': capability_schemas,
         'events': events,
+        'status': status_function_schema if status_function_schema else {'type': 'null'},
         'components': {
-            'schemas': schemas,
+            'schemas': shared_schemas,
             'messageTraits': {
                 # this is where we can define our message headers
                 'commonHeaders': {
@@ -574,21 +607,6 @@ def get_schema_and_functions_from_capability_implementations(
         },
     }
 
-    if capability_type_docs != '':
-        asyncapi_spec['info']['description'] = capability_type_docs  # type: ignore[index]
-
-    if status_function_schema:
-        asyncapi_spec['status'] = status_function_schema
-
-    """
-    TODO - might want to include these fields
-    "securitySchemes": {},
-    "operationTraits": {},
-    "externalDocumentation": {
-        "url": "https://example.com",  # REQUIRED
-    },
-    """
-
     return (
         asyncapi_spec,
         function_map,

{intersect_sdk-0.7.0 → intersect_sdk-0.8.1}/src/intersect_sdk/app_lifecycle.py

@@ -82,7 +82,7 @@ class SignalHandler:
         ----------
         signal (int): signal code.
         """
-        logger.warning('shutting down and handling signal %d' % signal)
+        logger.warning('shutting down and handling signal %s', signal)
         if self._cleanup_callback:
             self._cleanup_callback(signal)
         self._exit.set()