msw-plugin-api 0.2.4__tar.gz → 0.4.0__tar.gz

{msw_plugin_api-0.2.4 → msw_plugin_api-0.4.0}/.gitignore

@@ -10,5 +10,8 @@ build/
 .mypy_cache/
 .ruff_cache/
 
+# library: do not commit the lockfile
+uv.lock
+
 # hatch-vcs generated version file
 src/msw_plugin_api/_version.py

msw_plugin_api-0.4.0/LICENSE

@@ -0,0 +1,35 @@
+BSD-3-Clause-NonCommercial
+
+Copyright (c) 2020-present, Lars B. Rollik.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted for NON-COMMERCIAL research, academic, and
+educational purposes only, provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+4. Any use of this software or its derivatives for COMMERCIAL purposes -
+   including sale, paid licensing, or providing paid services built on it -
+   requires a separate commercial licence. Contact lars@rollik.me.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

msw_plugin_api-0.4.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.5
+Name: msw-plugin-api
+Version: 0.4.0
+Summary: Minimal structural interfaces for MSW plugin packages
+Project-URL: Homepage, https://github.com/MurineShiftWork/msw-plugin-api
+Project-URL: Issue Tracker, https://github.com/MurineShiftWork/msw-plugin-api/issues
+Author-email: "Lars B. Rollik" <lars@rollik.me>
+License: BSD-3-Clause-NonCommercial
+        
+        Copyright (c) 2020-present, Lars B. Rollik.
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted for NON-COMMERCIAL research, academic, and
+        educational purposes only, provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice,
+           this list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its contributors
+           may be used to endorse or promote products derived from this software
+           without specific prior written permission.
+        
+        4. Any use of this software or its derivatives for COMMERCIAL purposes -
+           including sale, paid licensing, or providing paid services built on it -
+           requires a separate commercial licence. Contact lars@rollik.me.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Free for non-commercial use
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: commitizen; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# msw-plugin-api
+
+Minimal structural interfaces for [MurineShiftWork](https://github.com/MurineShiftWork/murineshiftwork) plugin packages.
+
+Zero dependencies (stdlib `typing` and `dataclasses` only). Provides:
+
+- `HostSessionInfo` — concrete dataclass plugins return after attaching
+- `HostSessionInfoProtocol` — `runtime_checkable` Protocol for structural typing
+- `HostSessionProtocol` — `runtime_checkable` Protocol for host session plugins
+
+## Usage
+
+```python
+from msw_plugin_api import HostSessionInfo, HostSessionProtocol
+
+class MyHostSession:
+    def attach(self, **kwargs) -> HostSessionInfo:
+        return HostSessionInfo(
+            backend="myplugin",
+            acquisition_name="subject__20260609_143022__ext",
+            subject="subject",
+            parent_directory="/data/recordings",
+        )
+
+    def start(self) -> None: ...
+    def stop(self) -> None: ...
+```
+
+Declare the plugin entry point in `pyproject.toml`:
+
+```toml
+[project.entry-points."msw.host"]
+myplugin = "my_package.session:MyHostSession"
+```
+
+## Plugin contract
+
+MSW core checks `isinstance(session, HostSessionProtocol)` at dispatch time.
+Plugins may implement the interface structurally (without importing this package)
+or depend on `msw-plugin-api` explicitly for IDE support and test conformance checks.
+
+## Camera backends
+
+A camera backend drives one group of cameras of a setup and registers under
+the `msw.camera` entry-point group, named as the setup's `backend:` key:
+
+```toml
+[project.entry-points."msw.camera"]
+flir_bonsai = "msw_flir_bonsai.msw:FlirBonsaiBackend"
+```
+
+The host calls `configure(settings, units)` once, then `preflight()`,
+`start(target)`, `stop(reason)` and `close()`. Each of `preflight`, `start` and
+`stop` returns one `UnitResult` per camera: a backend reports a missing or failed
+camera instead of raising, and the host decides whether that aborts the run.
+`configure` raises `CameraConfigError` for invalid settings, so a broken setup
+fails before any hardware starts. `load_camera_backend(name)` finds and creates
+an installed backend.

{msw_plugin_api-0.2.4 → msw_plugin_api-0.4.0}/README.md

@@ -38,3 +38,21 @@ myplugin = "my_package.session:MyHostSession"
 MSW core checks `isinstance(session, HostSessionProtocol)` at dispatch time.
 Plugins may implement the interface structurally (without importing this package)
 or depend on `msw-plugin-api` explicitly for IDE support and test conformance checks.
+
+## Camera backends
+
+A camera backend drives one group of cameras of a setup and registers under
+the `msw.camera` entry-point group, named as the setup's `backend:` key:
+
+```toml
+[project.entry-points."msw.camera"]
+flir_bonsai = "msw_flir_bonsai.msw:FlirBonsaiBackend"
+```
+
+The host calls `configure(settings, units)` once, then `preflight()`,
+`start(target)`, `stop(reason)` and `close()`. Each of `preflight`, `start` and
+`stop` returns one `UnitResult` per camera: a backend reports a missing or failed
+camera instead of raising, and the host decides whether that aborts the run.
+`configure` raises `CameraConfigError` for invalid settings, so a broken setup
+fails before any hardware starts. `load_camera_backend(name)` finds and creates
+an installed backend.

msw_plugin_api-0.4.0/VERSION

@@ -0,0 +1 @@
+0.4.0

{msw_plugin_api-0.2.4 → msw_plugin_api-0.4.0}/pyproject.toml

@@ -52,7 +52,7 @@ dev = [
 [tool.commitizen]
 name = "cz_conventional_commits"
 version_provider = "commitizen"
-version = "0.2.4"
+version = "0.4.0"
 version_files = ["VERSION"]
 tag_format = "v$version"
 update_changelog_on_bump = false

{msw_plugin_api-0.2.4 → msw_plugin_api-0.4.0}/src/msw_plugin_api/__init__.py

@@ -95,3 +95,69 @@ class HostSessionProtocol(Protocol):
     def stop(self) -> None:
         """Stop the recording session on the backend."""
         ...
+
+
+@runtime_checkable
+class MetadataProtocol(Protocol):
+    """Structural protocol for an MSW metadata section.
+
+    A metadata addon owns exactly one top-level subtree of the manifest
+    ``metadata`` key-tree (e.g. ``metadata.probes``, ``metadata.opto``). It
+    keeps its schema in its own package and advertises itself with an entry
+    point::
+
+        [project.entry-points."msw.metadata"]
+        probes = "my_package.metadata:ProbesMetadata"
+
+    MSW core discovers these via ``importlib.metadata`` and checks
+    ``isinstance(obj, MetadataProtocol)``, so any object exposing ``subtree``,
+    ``schema_version``, and ``validate`` satisfies it (no import of this
+    package required). ``validate`` must be non-fatal: it returns a list of
+    human-readable warnings and never raises, because ``metadata`` is optional
+    and legacy/partial trees must still load.
+
+    Attributes:
+        subtree: The reserved top-level metadata key this addon owns.
+        schema_version: The version of this subtree's schema.
+    """
+
+    subtree: str
+    schema_version: int
+
+    def validate(self, block: object) -> list[str]:
+        """Validate this addon's metadata subtree.
+
+        Args:
+            block: The value at ``metadata[self.subtree]``.
+
+        Returns:
+            A list of human-readable warnings (empty when valid). Never raises.
+        """
+        ...
+
+
+from msw_plugin_api.camera import (  # noqa: E402
+    CAMERA_ENTRY_POINT_GROUP,
+    CameraBackend,
+    CameraConfigError,
+    CameraTarget,
+    CameraUnitSpec,
+    UnitResult,
+    camera_backend_names,
+    load_camera_backend,
+)
+
+__all__ = [
+    "CAMERA_ENTRY_POINT_GROUP",
+    "CameraBackend",
+    "CameraConfigError",
+    "CameraTarget",
+    "CameraUnitSpec",
+    "HostSessionInfo",
+    "HostSessionInfoProtocol",
+    "HostSessionProtocol",
+    "MetadataProtocol",
+    "UnitResult",
+    "camera_backend_names",
+    "load_camera_backend",
+]

{msw_plugin_api-0.2.4 → msw_plugin_api-0.4.0}/src/msw_plugin_api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.4'
-__version_tuple__ = version_tuple = (0, 2, 4)
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)
 
 __commit_id__ = commit_id = None

msw_plugin_api-0.4.0/src/msw_plugin_api/camera.py

@@ -0,0 +1,194 @@
+"""Camera backend contract.
+
+A camera backend drives one group of cameras of a setup (for example the FLIR
+cameras run through Bonsai, or a Raspberry Pi camera ensemble). The host (MSW
+core) owns the session: it decides which groups record, where they write, and
+whether a failed camera aborts the run. A backend only drives its cameras and
+reports what happened to each one.
+
+Division of responsibility:
+
+- **Backends report, the host decides.** ``preflight``, ``start`` and ``stop``
+  return one ``UnitResult`` per camera and do not raise because a camera failed.
+  An exception escaping a backend is treated by the host as every camera of the
+  group failing.
+- **Configuration errors raise.** ``configure`` raises ``CameraConfigError`` when
+  the backend settings or units are invalid, so a broken setup fails at load
+  time, before any hardware is touched.
+- **``stop`` is idempotent** and saves everything it can, whatever the state.
+
+Backends are found through the ``msw.camera`` entry-point group; the entry
+point names the backend as it appears in a setup's ``backend:`` key::
+
+    [project.entry-points."msw.camera"]
+    flir_bonsai = "msw_flir_bonsai.msw:FlirBonsaiBackend"
+
+The entry point must load a class (or factory) that takes no arguments; the
+host then calls ``configure`` once before any other method.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from importlib.metadata import entry_points
+from typing import TYPE_CHECKING, Any, Final, Protocol, runtime_checkable
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+#: Entry-point group under which camera backends register.
+CAMERA_ENTRY_POINT_GROUP: Final = "msw.camera"
+
+# Unit states reported in ``UnitResult.state``.
+UNIT_READY: Final = "ready"  # reachable and identified; not recording
+UNIT_RECORDING: Final = "recording"
+UNIT_STOPPED: Final = "stopped"  # stopped cleanly, files saved
+UNIT_MISSING: Final = "missing"  # not found (unplugged, unreachable, wrong id)
+UNIT_FAILED: Final = "failed"  # found but did not do what was asked
+
+UNIT_STATES: Final = frozenset(
+    {UNIT_READY, UNIT_RECORDING, UNIT_STOPPED, UNIT_MISSING, UNIT_FAILED}
+)
+
+
+class CameraConfigError(ValueError):
+    """The backend settings or camera units of a setup are invalid."""
+
+
+@dataclass
+class CameraUnitSpec:
+    """One camera as the setup names it.
+
+    Args:
+        name: Camera name, unique across all camera groups of a setup. Used in
+            file names and to select cameras per task.
+        hw_id: Hardware identity, when the backend has one: a FLIR serial
+            number, a Raspberry Pi hostname. Optional.
+        settings: Backend-specific per-camera keys (for example a FLIR SDK
+            ``index``), validated by the backend in ``configure``.
+    """
+
+    name: str
+    hw_id: str = ""
+    settings: dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass
+class CameraTarget:
+    """Where a camera group writes one recording.
+
+    Args:
+        acqdir: Absolute local directory of the camera acquisition.
+        basename: Basename of the camera acquisition; per-camera files are
+            named below it.
+        host_relpath: Folder of the behaviour acquisition, relative to the data
+            root. For backends that record on another machine under their own
+            data root.
+        host_name: Basename of the behaviour acquisition, for the same backends.
+    """
+
+    acqdir: str
+    basename: str
+    host_relpath: str = ""
+    host_name: str = ""
+
+
+@dataclass
+class UnitResult:
+    """What happened to one camera.
+
+    Args:
+        name: The camera's ``CameraUnitSpec.name``.
+        ok: Whether the camera did what was asked.
+        state: One of ``UNIT_STATES``.
+        error: Human-readable reason when ``ok`` is false.
+        error_code: Stable machine-readable reason, backend-defined.
+        files: Files the camera wrote, relative to the acquisition directory
+            (or to the backend's own data root for remote backends).
+        extra: Backend facts worth keeping in the manifest: serial, hostname,
+            software versions, clock anchors, frame counts.
+    """
+
+    name: str
+    ok: bool
+    state: str
+    error: str = ""
+    error_code: str = ""
+    files: list[str] = field(default_factory=list)
+    extra: dict[str, Any] = field(default_factory=dict)
+
+    def __post_init__(self) -> None:
+        if self.state not in UNIT_STATES:
+            raise ValueError(
+                f"unknown camera state {self.state!r}; "
+                f"expected one of {sorted(UNIT_STATES)}"
+            )
+
+
+@runtime_checkable
+class CameraBackend(Protocol):
+    """Structural protocol for a camera backend driving one camera group.
+
+    Attributes:
+        acq_type: Namespace acquisition type the group records under
+            (``video_flir``, ``video_rce``, ...).
+        version: Version of the backend package, recorded in the manifest.
+    """
+
+    acq_type: str
+    version: str
+
+    def configure(
+        self, settings: Mapping[str, Any], units: list[CameraUnitSpec]
+    ) -> None:
+        """Validate and store the group's settings and cameras.
+
+        Raises:
+            CameraConfigError: The settings or units are invalid.
+        """
+        ...
+
+    def preflight(self) -> list[UnitResult]:
+        """Reach and identify every camera without recording."""
+        ...
+
+    def start(self, target: CameraTarget) -> list[UnitResult]:
+        """Start recording into ``target``; one result per camera."""
+        ...
+
+    def stop(self, reason: str) -> list[UnitResult]:
+        """Stop every camera and save what it can. Safe to call repeatedly."""
+        ...
+
+    def close(self) -> None:
+        """Release connections and processes. Safe to call repeatedly."""
+        ...
+
+
+def camera_backend_names() -> list[str]:
+    """Names of the installed camera backends, sorted."""
+    return sorted(ep.name for ep in entry_points(group=CAMERA_ENTRY_POINT_GROUP))
+
+
+def load_camera_backend(name: str) -> CameraBackend:
+    """Create the installed camera backend registered as ``name``.
+
+    Raises:
+        LookupError: No installed package registers a backend of that name.
+        TypeError: The registered object does not satisfy ``CameraBackend``.
+    """
+    matches = [
+        ep for ep in entry_points(group=CAMERA_ENTRY_POINT_GROUP) if ep.name == name
+    ]
+    if not matches:
+        installed = ", ".join(camera_backend_names()) or "none"
+        raise LookupError(
+            f"camera backend {name!r} is not installed (installed: {installed})"
+        )
+    backend = matches[0].load()()
+    if not isinstance(backend, CameraBackend):
+        raise TypeError(
+            f"camera backend {name!r} ({matches[0].value}) "
+            "does not implement CameraBackend"
+        )
+    return backend

msw_plugin_api-0.2.4/LICENSE

@@ -1,31 +0,0 @@
-Copyright (c) 2020-present Lars B. Rollik. All rights reserved.
-
-Permission is granted, free of charge, to use, copy, modify, and distribute
-this software and associated documentation files (the "Software") for
-non-commercial research or academic purposes only, subject to the following
-conditions:
-
-1. This copyright notice and permission notice must be included in all copies
-   or substantial portions of the Software.
-
-2. Any publication, presentation, or product that uses or builds upon the
-   Software must give clear attribution to the original work and its authors.
-
-3. Commercial use is prohibited without a separate written commercial licence
-   agreement with the copyright holder. Commercial use means incorporation of
-   the Software into anything for which fees or other compensation are charged
-   or received, including commercial products and commercial services.
-
-4. No patent licence, express or implied, is granted under these terms. Any
-   use that would require a patent licence from the copyright holder requires
-   a separate written agreement.
-
-5. Redistribution, in source or binary form, is permitted only for
-   non-commercial purposes and must retain this notice unmodified.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM,
-DAMAGES, OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR DEALINGS IN THE SOFTWARE.
-
-For commercial or patent licensing enquiries contact: lars@rollik.me

msw_plugin_api-0.2.4/PKG-INFO

@@ -1,95 +0,0 @@
-Metadata-Version: 2.4
-Name: msw-plugin-api
-Version: 0.2.4
-Summary: Minimal structural interfaces for MSW plugin packages
-Project-URL: Homepage, https://github.com/MurineShiftWork/msw-plugin-api
-Project-URL: Issue Tracker, https://github.com/MurineShiftWork/msw-plugin-api/issues
-Author-email: "Lars B. Rollik" <lars@rollik.me>
-License: Copyright (c) 2020-present Lars B. Rollik. All rights reserved.
-        
-        Permission is granted, free of charge, to use, copy, modify, and distribute
-        this software and associated documentation files (the "Software") for
-        non-commercial research or academic purposes only, subject to the following
-        conditions:
-        
-        1. This copyright notice and permission notice must be included in all copies
-           or substantial portions of the Software.
-        
-        2. Any publication, presentation, or product that uses or builds upon the
-           Software must give clear attribution to the original work and its authors.
-        
-        3. Commercial use is prohibited without a separate written commercial licence
-           agreement with the copyright holder. Commercial use means incorporation of
-           the Software into anything for which fees or other compensation are charged
-           or received, including commercial products and commercial services.
-        
-        4. No patent licence, express or implied, is granted under these terms. Any
-           use that would require a patent licence from the copyright holder requires
-           a separate written agreement.
-        
-        5. Redistribution, in source or binary form, is permitted only for
-           non-commercial purposes and must retain this notice unmodified.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM,
-        DAMAGES, OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE
-        SOFTWARE OR THE USE OR DEALINGS IN THE SOFTWARE.
-        
-        For commercial or patent licensing enquiries contact: lars@rollik.me
-License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: Free for non-commercial use
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Provides-Extra: dev
-Requires-Dist: commitizen; extra == 'dev'
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: pytest>=8; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# msw-plugin-api
-
-Minimal structural interfaces for [MurineShiftWork](https://github.com/MurineShiftWork/murineshiftwork) plugin packages.
-
-Zero dependencies (stdlib `typing` and `dataclasses` only). Provides:
-
-- `HostSessionInfo` — concrete dataclass plugins return after attaching
-- `HostSessionInfoProtocol` — `runtime_checkable` Protocol for structural typing
-- `HostSessionProtocol` — `runtime_checkable` Protocol for host session plugins
-
-## Usage
-
-```python
-from msw_plugin_api import HostSessionInfo, HostSessionProtocol
-
-class MyHostSession:
-    def attach(self, **kwargs) -> HostSessionInfo:
-        return HostSessionInfo(
-            backend="myplugin",
-            acquisition_name="subject__20260609_143022__ext",
-            subject="subject",
-            parent_directory="/data/recordings",
-        )
-
-    def start(self) -> None: ...
-    def stop(self) -> None: ...
-```
-
-Declare the plugin entry point in `pyproject.toml`:
-
-```toml
-[project.entry-points."msw.host"]
-myplugin = "my_package.session:MyHostSession"
-```
-
-## Plugin contract
-
-MSW core checks `isinstance(session, HostSessionProtocol)` at dispatch time.
-Plugins may implement the interface structurally (without importing this package)
-or depend on `msw-plugin-api` explicitly for IDE support and test conformance checks.

msw_plugin_api-0.2.4/VERSION

@@ -1 +0,0 @@
-0.2.4