omnibase_spi 0.18.0

ONEX Service Provider Interface - Protocol definitions

omnibase_spi

Service provider interface protocols for the ONEX platform.

Install

uv add omnibase-spi

Minimal Example

from omnibase_spi.protocols.event_bus import ProtocolEventBusProducer

class MyProducer(ProtocolEventBusProducer):
    """Implement the event bus producer protocol."""

    async def publish(self, topic: str, payload: bytes) -> None:
        # Your implementation here
        ...

Key Features

• 176+ protocol interfaces: Runtime-checkable protocols for all ONEX service boundaries
• 22 domains: Event bus, handlers, nodes, registry, storage, and more
• Zero implementations: Protocols only -- concrete implementations live in omnibase_infra
• Structural typing: All protocols use @runtime_checkable for duck typing
• Contract-first: Protocols define the contract, implementations fulfill it

Documentation

• Protocol registry
• Architecture
• CLAUDE.md -- developer context and conventions
• AGENT.md -- LLM navigation guide

License

MIT