Skip to main content

Typing protocols, aliases, generics, and shared type helpers for Tigrbl framework packages and extensions.

Project description

tigrbl-typing

Tigrbl logo

Typing protocols, aliases, generics, and shared type helpers for Tigrbl framework packages and extensions.

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

What is tigrbl-typing?

Typing protocols, aliases, generics, and shared type helpers for Tigrbl framework packages and extensions.

Why use tigrbl-typing?

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

When should I install tigrbl-typing?

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

Who is tigrbl-typing for?

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

Where does tigrbl-typing fit?

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

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

Surface Coverage

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

What It Owns

tigrbl-typing 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_typing: channel, gw/, phases, protocols, request, status/, types/, vendor/

Public API and Import Surface

  • Import roots: tigrbl_typing.
  • Public symbols: public surface is module-oriented; import the package boundary and inspect submodules as needed.
  • Workspace dependencies: none declared.
  • External runtime dependencies: pydantic>=2.10,<3.

Usage Examples

Verify the installed package

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

Import the package boundary

import importlib

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

Inspect available modules

import importlib
import pkgutil

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

Use with the facade when building applications

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

How To Choose This Package

Choose tigrbl-typing 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-typing. 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_typing-0.4.2.dev4.tar.gz (23.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_typing-0.4.2.dev4-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tigrbl_typing-0.4.2.dev4.tar.gz
  • Upload date:
  • Size: 23.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_typing-0.4.2.dev4.tar.gz
Algorithm Hash digest
SHA256 4ff08b518110b2345feeb8a61a287b9124cff24268f80e0e749d1c25654a97fc
MD5 63dca0539d42e950861d23ca9c44764d
BLAKE2b-256 8a982b39d7c161528b9d5026c05efc8937212cfd0332650626138685422bc0ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tigrbl_typing-0.4.2.dev4-py3-none-any.whl
  • Upload date:
  • Size: 28.1 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_typing-0.4.2.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 c91a5039cf933f9f9dd3a93662db287f940f52ba8c7464d50fad55c210b0c64f
MD5 91f0500c106f56369bdecaedd8e42236
BLAKE2b-256 c150f11016f41817535b589bd23b330dc8372773737bb10cb4f388f47ce8498a

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