Skip to main content

Runtime pipeline helpers and execution bridge surfaces for Tigrbl ASGI applications, transports, and operation dispatch.

Project description

tigrbl-runtime

Tigrbl logo

Runtime pipeline helpers and execution bridge surfaces for Tigrbl ASGI applications, transports, and operation dispatch.

PyPI version for tigrbl-runtime Downloads for tigrbl-runtime Discord community for tigrbl-runtime Repository hits for tigrbl-runtime README Apache 2.0 license Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl-runtime Workspace group for tigrbl-runtime

What is tigrbl-runtime?

Runtime pipeline helpers and execution bridge surfaces for Tigrbl ASGI applications, transports, and operation dispatch.

Why use tigrbl-runtime?

Use it when you need this foundational Tigrbl layer directly as a small, focused dependency.

When should I install tigrbl-runtime?

Install it for extension packages, package-local tests, or internals that need this boundary without the whole facade.

Who is tigrbl-runtime for?

Framework maintainers, extension authors, and advanced users composing Tigrbl from split packages.

Where does tigrbl-runtime fit?

tigrbl-runtime lives at pkgs/core/tigrbl_runtime and serves a focused layer in the split Tigrbl framework.

How does tigrbl-runtime work?

It owns a narrow layer in the split workspace and is consumed by higher-level packages through explicit dependencies.

Certification Status

  • Package status: governed package in the tigrbl/tigrbl workspace.
  • Governance source: SSOT registry.
  • Release evidence: publish workflow validates package builds, tests, GitHub release assets, and PyPI publication for managed packages.
  • Local certification guard: pkgs/core/tigrbl_tests/tests/unit/test_package_badges_and_notices.py verifies every package README keeps the Discord badge, Apache 2.0 badge, explicit Python-version badge, LICENSE, and NOTICE.
  • Scope note: this README documents the package boundary. Runtime feature support remains governed by .ssot/ entities and the conformance docs linked below.

Install

uv add tigrbl-runtime
pip install tigrbl-runtime

Surface Coverage

Surface Value
PyPI package tigrbl-runtime
Repository path pkgs/core/tigrbl_runtime
Python import root tigrbl_runtime
Console scripts none declared
Entry points none declared
Optional extras none declared
Legal files LICENSE, NOTICE
Supported Python `3.10

What It Owns

tigrbl-runtime owns the foundational framework package boundary. It should be installed when you need this package's focused responsibility without assuming every other Tigrbl workspace package is present.

Implementation orientation:

  • tigrbl_runtime: callbacks, channel/, config/, executors/, handle, protocol/, runtime/, transactions, webhooks
  • tigrbl_runtime/rust/: deprecated compatibility shims only; Rust execution is unavailable.

Runtime authoring BCP:

  • Do use this package for runtime-owned routing, request execution, transport-unit execution, framing atoms, transport channels, transaction helpers, and kernel integration.
  • Do keep handler invocation, transaction progression, error handling, and transport emission aligned with compiled plans.
  • Do not make application route handlers, FastAPI/Starlette objects, direct SQLAlchemy session calls, or ad-hoc engine construction the runtime contract.
  • Do not bypass kernel plans or lifecycle phases when adding REST, JSON-RPC, stream, SSE, WebSocket, or WebTransport behavior.
  • Avoid hiding behavior in transport wrappers that diagnostics and compiled plans cannot inspect.

Public API and Import Surface

  • Import roots: tigrbl_runtime.
  • Public symbols: Runtime, RuntimeBase.
  • Rust-named symbols live only under tigrbl_runtime.rust as deprecated compatibility shims and must not be used for execution.
  • Workspace dependencies: tigrbl-typing, tigrbl-kernel, tigrbl-atoms, tigrbl-base, tigrbl-core.
  • External runtime dependencies: numba>=0.61.2.

Usage Examples

Verify the installed package

python -m pip show tigrbl-runtime
python - <<'PY'
from importlib.metadata import version
print(version("tigrbl-runtime"))
PY

Import the package boundary

import importlib

module = importlib.import_module("tigrbl_runtime")
print(module.__name__)

Import a public symbol

from tigrbl_runtime import Runtime

print(Runtime)

Use with the facade when building applications

uv add tigrbl tigrbl-runtime
python - <<'PY'
import tigrbl
print(tigrbl.__name__)
PY

How To Choose This Package

Choose tigrbl-runtime when the quick-answer table matches your use case. Choose tigrbl instead when you want the full public facade. Choose a lower-level package such as tigrbl-core, tigrbl-base, or tigrbl-runtime when you are building framework extensions or testing a specific internal boundary.

Related Packages

Documentation Links

Support

Package-local Boundary

This README is the package-local distribution entry point for tigrbl-runtime. It answers install, usage, API, ownership, and certification-orientation questions for this package. Broader architectural decisions, release status, and cross-package proof chains remain in the repository-level docs and SSOT registry.

License

Licensed under the Apache License, Version 2.0. See LICENSE, NOTICE, and the official Apache 2.0 license text.

Project details


Download files

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

Source Distribution

tigrbl_runtime-0.4.4.dev1.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

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

tigrbl_runtime-0.4.4.dev1-py3-none-any.whl (83.3 kB view details)

Uploaded Python 3

File details

Details for the file tigrbl_runtime-0.4.4.dev1.tar.gz.

File metadata

  • Download URL: tigrbl_runtime-0.4.4.dev1.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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 tigrbl_runtime-0.4.4.dev1.tar.gz
Algorithm Hash digest
SHA256 f57f7b68aa8b6faf268c354c1fc46787c6a7f5b4f74c30db3ba43a6a52014b40
MD5 3abde54a987333cf0706049a88d0bc85
BLAKE2b-256 f94a39dd8a22b87e337da73063840b983841d20723eed90ce705f064409c69bf

See more details on using hashes here.

File details

Details for the file tigrbl_runtime-0.4.4.dev1-py3-none-any.whl.

File metadata

  • Download URL: tigrbl_runtime-0.4.4.dev1-py3-none-any.whl
  • Upload date:
  • Size: 83.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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 tigrbl_runtime-0.4.4.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 15231aec552680c50bc9f40d39e7926f90d501e47858880f350b9dcea783a594
MD5 76e3beb00ee21d1408894624c795e7f8
BLAKE2b-256 a8c4c05ca37d6fab6fa6a0510c0b71baa6dc64d4f81a9fa61afb84087b12c9b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page