Skip to main content

Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.

Project description

tigrbl-base

Tigrbl logo

Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.

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

What is tigrbl-base?

Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.

Why use tigrbl-base?

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

When should I install tigrbl-base?

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

Who is tigrbl-base for?

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

Where does tigrbl-base fit?

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

How does tigrbl-base 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-base
pip install tigrbl-base

Surface Coverage

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

What It Owns

tigrbl-base 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_base: _base/, column/

Public API and Import Surface

  • Import roots: tigrbl_base.
  • Public symbols: public surface is module-oriented; import the package boundary and inspect submodules as needed.
  • Workspace dependencies: tigrbl-core, tigrbl-atoms.
  • External runtime dependencies: sqlalchemy>=2.0, pydantic>=2.0.

Usage Examples

Verify the installed package

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

Import the package boundary

import importlib

module = importlib.import_module("tigrbl_base._base")
print(module.__name__)

Inspect available modules

import importlib
import pkgutil

module = importlib.import_module("tigrbl_base._base")
for info in pkgutil.iter_modules(getattr(module, "__path__", [])):
    print(info.name)

Use with the facade when building applications

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

How To Choose This Package

Choose tigrbl-base 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-base. 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_base-0.4.2.dev4.tar.gz (37.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_base-0.4.2.dev4-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

Details for the file tigrbl_base-0.4.2.dev4.tar.gz.

File metadata

  • Download URL: tigrbl_base-0.4.2.dev4.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.18 {"installer":{"name":"uv","version":"0.11.18","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_base-0.4.2.dev4.tar.gz
Algorithm Hash digest
SHA256 fcee6d4cfce022dd89a78351cea0434a2558d22a59405a7661087d1edfcbe1a7
MD5 e23f713b52727d9602cba27b030da76c
BLAKE2b-256 1dd5d2aa3623ea4faa34ff6c3c132c5384d1685358b1db7db1887bc1f87f4036

See more details on using hashes here.

File details

Details for the file tigrbl_base-0.4.2.dev4-py3-none-any.whl.

File metadata

  • Download URL: tigrbl_base-0.4.2.dev4-py3-none-any.whl
  • Upload date:
  • Size: 47.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.18 {"installer":{"name":"uv","version":"0.11.18","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_base-0.4.2.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 b9767423b09c9820230efd83c6ee700d04943b233871d16a477ed73ceaf048e5
MD5 b2142f83c7da9fa6d85847d537496a9a
BLAKE2b-256 73fe89d154758d06a11e5faceafad477bd8868f4282c4b5724d344c916ede2ee

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