omnibase_core
omnibase_core is the ONEX (OmniNode eXecution) platform kernel. It owns node execution, contracts,
core models, validation tooling, and the canonical architecture vocabulary used
by downstream OmniNode repos.
Badge note: this tracks the PR-triggered
ci.ymlrun (event=pull_request), not the push-triggered run ondev. The push/schedule-triggered run is permanently red by design: its Contract Compliance Check job fails closed on every non-PR event because its DoD checks are PR-scoped and correctly refuse to vacuously pass outside PR context. That is an intentional, documented tradeoff, not a regression — see thecontract-compliancejob comment in.github/workflows/ci.ymlfor the rationale.
Who Uses It
Use this repo when you need to:
- Use ONEX core types, nodes, contracts, and validation tools.
- Build a contract-driven EFFECT, COMPUTE, REDUCER, or ORCHESTRATOR node.
- Extend Core internals such as validation, contracts, node execution, handlers, model conventions, or runtime-development scaffolding.
Downstream runtime implementations, infrastructure clients, workflow packages, dashboard projections, and thin wrapper tooling should link back here for Core architecture and validation truth rather than duplicating it.
What This Repo Owns
- ONEX node base classes and execution vocabulary.
- Contract models, handler contracts, subcontracts, and contract validation.
- Core event envelopes, error models, container patterns, and dependency injection conventions.
- Core documentation standards for ONEX architecture and node construction.
- Shared validation entrypoints such as
onex-validate-links,onex-validate-topics,check-local-paths, and string-version checks.
What This Repo Does Not Own
- Concrete infrastructure, Kafka/Postgres/Infisical clients, runtime host
deployment, or registration operations. Those belong in
omnibase_infra. - Protocol-only service interfaces for downstream implementation packages.
Those belong in
omnibase_spi. - Zero-upstream structural DTOs and compatibility shims. Those belong in
omnibase_compat. - Portable workflow package ownership. That belongs in
omnimarket.
Track 1: Use The Package
Install:
uv add omnibase_core
Install optional surfaces only when needed:
uv add "omnibase_core[spi]"
uv add "omnibase_core[kafka]"
uv add "omnibase_core[full]"
Common imports:
from omnibase_core.nodes import NodeCompute
from omnibase_core import ModelOnexError
Core is a Python 3.12+ package. Package metadata, optional dependency groups,
and CLI entrypoints are declared in pyproject.toml.
Track 2: Build A Node
Every ONEX node starts from one of the four core archetypes:
- EFFECT: external I/O
- COMPUTE: transformation and validation
- REDUCER: state aggregation
- ORCHESTRATOR: workflow coordination
Minimal COMPUTE node:
from omnibase_core.nodes import NodeCompute
class NodeMyFeature(NodeCompute):
pass
The preferred path is contract-driven: YAML declares inputs, outputs, capabilities, bindings, and lifecycle constraints; custom Python behavior is added only when the contract cannot express the behavior.
Start here, in the knowledge base:
Track 3: Extend Validation Or Runtime Internals
Core owns validators and development/runtime internals that other repos consume. Use these commands before changing validation, contracts, docs, or architecture surface:
uv sync --dev --frozen
uv run onex-validate-links --verbose
uv run pytest tests/ -q
Focused validation entrypoints:
uv run onex-validate-topics . --verbose
uv run check-local-paths docs src scripts
uv run validate-string-versions src
For ownership, downstream-consumer guidance, and cross-repo usage, see Validation Ownership.
Documentation
Full documentation → https://github.com/OmniNode-ai/knowledge-base
This repository ships code, contracts, and executable configuration. Its prose
documentation lives in the OmniNode knowledge base; nothing is duplicated here,
and the kb-doc-gate check (.kb-doc-gate.yaml, mode: strict) fails any pull
request that reintroduces markdown outside the allowed set.
High-signal entrypoints:
- Architecture Overview
- ONEX Four-Node Architecture
- Contract System
- Handler Contract Guide
- Validation Framework
- Validation Ownership
- Decision records
- Contributing
- Security
License
1 maintainer
Release files for omnibase_core 0.47.19
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| omnibase_core-0.47.19.tar.gz | 9.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| omnibase_core-0.47.19-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.5 MB
Release files / omnibase_core-0.47.19.tar.gz
| Download URL | omnibase_core-0.47.19.tar.gz |
|---|---|
| Size | 9.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b134a9c35e9b33c3b0422b686f3b5bfcd30011a06ee39f6a851f3d4e46032e7c
|
|
BLAKE2b-256 checksum How to use checksums |
752d3af9cb51d512815fe700448a05f9ccf1c3ac109d7f707c5bb326e841d62c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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}
|
Release files / omnibase_core-0.47.19-py3-none-any.whl
| Download URL | omnibase_core-0.47.19-py3-none-any.whl |
|---|---|
| Size | 6.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
982ec45c9fc588becb1ea9c96b45bd25e26b69438f0ea847a509d850a7c7579d
|
|
BLAKE2b-256 checksum How to use checksums |
9ecc0a8a71b6f9c4970d59571c07120f98bdee97c9568df63c2972dd1284edde
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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}
|
