omninode

omnibase_spi

omnibase_spi is the Service Provider Interface package for ONEX (OmniNode eXecution). It defines protocol contracts, small wire-format contracts, and SPI exceptions that other repos implement or consume.

This package is intentionally not the implementation layer. Concrete runtime, transport, service, registry, and I/O behavior belongs in implementation repos such as omnibase_infra.

Current Role

Defines 232 protocol_*.py files across 39 protocol domains.
Provides runtime-checkable Python Protocol contracts for service boundaries.
Provides frozen, data-only contracts in src/omnibase_spi/contracts/ for selected cross-boundary wire formats.
Imports omnibase_core models and types where protocol signatures need shared platform data shapes.
Must not import implementation packages such as omnibase_infra.
Must not contain service implementations, business workflows, state machines, transport clients, or general domain Pydantic models.

Dependency Direction

The import direction is deliberate and non-obvious:

Application and product repos
        |
        v
omnibase_spi  ---- imports models/types ---->  omnibase_core
        ^                                      ^
        | implements protocols                 | uses models/types
        |
omnibase_infra and other implementation repos --+

Allowed:

omnibase_spi -> omnibase_core
omnibase_infra -> omnibase_spi
omnibase_infra -> omnibase_core
Product repos importing SPI protocols for type boundaries

Forbidden:

omnibase_core -> omnibase_spi
omnibase_spi -> omnibase_infra
Protocol files that perform I/O or instantiate concrete services
General domain BaseModel classes in SPI protocol modules

See Dependency Direction for the full rule, examples, and rationale.

Install

uv add omnibase_spi

For local workspace development, use the repository lockfile and the configured omnibase-core source:

uv sync --group dev

Minimal Protocol Example

from typing import Protocol, runtime_checkable


@runtime_checkable
class ProtocolExampleService(Protocol):
    """Service boundary implemented outside omnibase_spi."""

    async def run(self, payload: bytes) -> bytes:
        """Run the service operation."""
        ...

Add A Protocol

Choose the domain under src/omnibase_spi/protocols/.
Create a protocol_<domain>_<name>.py file.
Name the public protocol Protocol<Name>.
Add @runtime_checkable.
Use ... method bodies only.
Import shared models from omnibase_core only when the signature requires canonical platform models or types.
Add or update tests under tests/.
Export the protocol from the domain __init__.py if it is public.

Common Commands

uv sync --group dev
uv run pytest
uv run mypy src/ --strict
uv run ruff check src/ tests/
uv run ruff format src/ tests/
python scripts/validation/run_all_validations.py
pre-commit run --all-files
uv build

Documentation

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnibase_spi-0.23.3.tar.gz (1.3 MB view details)

Uploaded Aug 30, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

omnibase_spi-0.23.3-py3-none-any.whl (744.6 kB view details)

Uploaded Aug 30, 2026 Python 3

File details

Details for the file omnibase_spi-0.23.3.tar.gz.

File metadata

Download URL: omnibase_spi-0.23.3.tar.gz
Upload date: Aug 30, 2026
Size: 1.3 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for omnibase_spi-0.23.3.tar.gz
Algorithm	Hash digest
SHA256	`c75a03bc087ff28f2490f7ff2d37f17f9f92b862c2b06b799b11c586cdc9279e`
MD5	`d17d5927dd21c16b164fa774e1114f88`
BLAKE2b-256	`55da03b89a9dbdb1cff7bf0347e32040c467d266ed5e6928bd350a6bc7056139`

See more details on using hashes here.

File details

Details for the file omnibase_spi-0.23.3-py3-none-any.whl.

File metadata

Download URL: omnibase_spi-0.23.3-py3-none-any.whl
Upload date: Aug 30, 2026
Size: 744.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for omnibase_spi-0.23.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`60bc58a91d83297c0b207d6d2c42c25280ee007e4cdce60cda2243744d520c3a`
MD5	`44d150cff8d1e06b9ae9866dbae65e48`
BLAKE2b-256	`f49b852e966c6024622f2775974fee0a8b1628dc45b62864e29eb845ee2bf1bf`