tigrbl_client 0.4.5.dev4

Typed Python client for Tigrbl REST and JSON-RPC APIs with sync and async calls, nested resource helpers, and optional Pydantic validation.

tigrbl_client

Typed Python client for Tigrbl REST and JSON-RPC APIs with sync and async calls, nested resource helpers, and optional Pydantic validation.

What is tigrbl_client?

Typed Python client for Tigrbl REST and JSON-RPC APIs with sync and async calls, nested resource helpers, and optional Pydantic validation.

Why use tigrbl_client?

Use it when a Python service or test suite needs a typed client for Tigrbl REST and JSON-RPC APIs.

When should I install tigrbl_client?

Install it in consumers, integration tests, SDK adapters, and automation that calls an already-running Tigrbl service.

Who is tigrbl_client for?

Client authors, API consumers, QA engineers, and service integration teams.

Where does tigrbl_client fit?

tigrbl_client lives at pkgs/core/tigrbl_client and serves calling Tigrbl services from Python clients and tests.

How does tigrbl_client work?

It wraps HTTP calls with sync and async helpers, optional API-key headers, REST CRUD helpers, JSON-RPC calls, and nested-resource helpers.

Install

uv add tigrbl_client

pip install tigrbl_client

Surface Coverage

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

What It Owns

tigrbl_client owns the client 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_client: _crud, _nested_crud, _rpc

Public API and Import Surface

• Import roots: tigrbl_client.
• Public symbols: NestedCRUDMixin, TigrblClient, _Schema.
• Workspace dependencies: none declared.
• External runtime dependencies: fastapi>=0.100.0, pydantic>=2.0.0.

Usage Examples

Verify the installed package

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

Call REST endpoints

from tigrbl_client import TigrblClient

with TigrblClient("https://api.example.com") as client:
    item = client.get("/items/1")
    created = client.post("/items", data={"name": "example"})

Call JSON-RPC endpoints

from tigrbl_client import TigrblClient

client = TigrblClient("https://api.example.com/rpc")
result = client.call("items.get", params={"id": 1})

Use async helpers

from tigrbl_client import TigrblClient

async with TigrblClient("https://api.example.com") as client:
    item = await client.aget("/items/1")

How To Choose This Package

Choose tigrbl_client 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

• tigrbl
• tigrbl_tests

Documentation Links

• Workspace docs
• Package catalog
• Package layout
• Current target
• Current state
• SSOT registry
• Release workflow

Support

• Community: Discord.
• Issues: GitHub Issues.
• Repository: pkgs/core/tigrbl_client.

Package-local Boundary

This README is the package-local distribution entry point for tigrbl_client. 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.

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.

License

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