tigrbl_spec 0.4.1.dev6__tar.gz → 0.4.2.dev3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tigrbl_spec
3
- Version: 0.4.1.dev6
3
+ Version: 0.4.2.dev3
4
4
  Summary: Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
5
5
  License: Apache License
6
6
  Version 2.0, January 2004
@@ -231,112 +231,58 @@ Project-URL: Organization, https://github.com/tigrbl
231
231
  Project-URL: Repository, https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec
232
232
  Description-Content-Type: text/markdown
233
233
 
234
- ![Tigrbl Logo](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png)
234
+ <div align="center">
235
+ <h1>tigrbl_spec</h1>
236
+ <img src="https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png" alt="Tigrbl logo" width="140"/>
237
+ <p><strong>Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.</strong></p>
238
+ <a href="https://pypi.org/project/tigrbl_spec/"><img src="https://img.shields.io/pypi/v/tigrbl_spec?label=PyPI" alt="PyPI version for tigrbl_spec"/></a>
239
+ <a href="https://pypi.org/project/tigrbl_spec/"><img src="https://static.pepy.tech/badge/tigrbl_spec" alt="Downloads for tigrbl_spec"/></a>
240
+ <a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_spec/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_spec/README.md.svg?label=hits" alt="Repository hits for tigrbl_spec README"/></a>
241
+ <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
242
+ <a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20to%203.15-3776ab" alt="Python requirement for tigrbl_spec"/></a>
243
+ <a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-core-1f6feb" alt="Workspace group for tigrbl_spec"/></a>
244
+ </div>
235
245
 
236
- <p align="center">
237
- <a href="https://pepy.tech/project/tigrbl_spec">
238
- <img src="https://static.pepy.tech/badge/tigrbl_spec" alt="Pepy downloads for tigrbl_spec"/></a>
239
- <a href="https://hits.sh/github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec/">
240
- <img src="https://hits.sh/github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec.svg" alt="Repository views for tigrbl_spec"/></a>
241
- <a href="https://pypi.org/project/tigrbl_spec/">
242
- <img src="https://img.shields.io/badge/python-3.10--3.14-blue" alt="Python 3.10 through 3.14"/></a>
243
- <a href="https://pypi.org/project/tigrbl_spec/">
244
- <img src="https://img.shields.io/pypi/l/tigrbl_spec" alt="PyPI license metadata for tigrbl_spec"/></a>
245
- <a href="https://pypi.org/project/tigrbl_spec/">
246
- <img src="https://img.shields.io/pypi/v/tigrbl_spec?label=tigrbl_spec&color=green" alt="PyPI version for tigrbl_spec"/></a>
247
- </p>
248
-
249
- ---
250
-
251
- <h1 align="center">Tigrbl spec</h1>
252
-
253
- **Inspect specification compatibility targets: [open `tigrbl_spec`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec).**
254
-
255
- tigrbl_spec is a specification package for shared interfaces, protocol definitions, compatibility targets, and specification artifacts for Tigrbl.
256
-
257
- `tigrbl_spec` is part of the Tigrbl package graph. It documents package-resident classes, concepts, extension points, and execution responsibilities while cross-linking to the facade, core specs, canonical mapping, runtime phases, concrete objects, operation packages, engine plugins, OpenAPI/OpenRPC documentation surfaces, and PyPI distributions that complete the system.
258
-
259
- ## Resident concepts
260
-
261
- - `tigrbl_spec` is the shared specification package for protocol definitions, compatibility targets, and planning-stage spec surfaces that are consumed by other Tigrbl packages.
262
- - Use this README for package-level spec guidance that is broader than one Python class but narrower than the governed repository docs.
246
+ ## Install
263
247
 
264
- ## Package ecosystem cross-links
248
+ ```bash
249
+ uv add tigrbl_spec
250
+ ```
265
251
 
266
- Every Tigrbl Python package links to its sibling distributions on PyPI so package indexes, search engines, answer engines, dependency scanners, and human readers can move through the installable package graph without falling back to source-tree paths.
252
+ ```bash
253
+ pip install tigrbl_spec
254
+ ```
267
255
 
268
- Core packages:
269
- - [`tigrbl`](https://pypi.org/project/tigrbl/) - Schema-first ASGI API framework for REST, JSON-RPC, OpenAPI, OpenRPC, SQLAlchemy models, typed validation, lifecycle hooks, and engine plugins.
270
- - [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/) - Runtime atom utilities for Tigrbl planning, dispatch, transport ingress, egress, and high-throughput ASGI execution pipelines.
271
- - [`tigrbl-base`](https://pypi.org/project/tigrbl-base/) - Abstract base interfaces for Tigrbl APIs, engines, providers, sessions, transports, and reusable runtime components.
272
- - [`tigrbl-canon`](https://pypi.org/project/tigrbl-canon/) - Canonical mapping, routing, symbol resolution, and naming utilities for Tigrbl framework packages and generated API surfaces.
273
- - [`tigrbl_client`](https://pypi.org/project/tigrbl_client/) - Typed Python client helpers for calling Tigrbl REST, JSON-RPC, OpenAPI, and generated schema-first API surfaces.
274
- - [`tigrbl-concrete`](https://pypi.org/project/tigrbl-concrete/) - Concrete Tigrbl implementations for reusable framework behavior, sessions, routes, responses, and base abstraction adapters.
275
- - [`tigrbl-core`](https://pypi.org/project/tigrbl-core/) - Core Tigrbl framework specifications, decorators, schemas, hooks, operations, and primitives for schema-first APIs.
276
- - [`tigrbl-kernel`](https://pypi.org/project/tigrbl-kernel/) - Kernel orchestration for composing Tigrbl runtime plans, bindings, operation dispatch, and optimized ASGI execution.
277
- - [`tigrbl-ops-olap`](https://pypi.org/project/tigrbl-ops-olap/) - Analytical OLAP operation boundaries for Tigrbl workloads, query-oriented APIs, and engine integrations.
278
- - [`tigrbl-ops-oltp`](https://pypi.org/project/tigrbl-ops-oltp/) - Transactional OLTP operation handlers for Tigrbl CRUD, bulk, REST, JSON-RPC, and database-backed workloads.
279
- - [`tigrbl-ops-realtime`](https://pypi.org/project/tigrbl-ops-realtime/) - Realtime, streaming, datagram, websocket, and event operation handlers for Tigrbl ASGI runtimes.
280
- - [`tigrbl-orm`](https://pypi.org/project/tigrbl-orm/) - SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.
281
- - [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/) - Runtime pipeline helpers and execution bridge surfaces for Tigrbl ASGI applications, transports, and operation dispatch.
282
- - [`tigrbl_spec`](https://pypi.org/project/tigrbl_spec/) (this package) - Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
283
- - [`tigrbl_tests`](https://pypi.org/project/tigrbl_tests/) - Reusable Tigrbl pytest fixtures, conformance assertions, integration helpers, and package test utilities.
284
- - [`tigrbl-typing`](https://pypi.org/project/tigrbl-typing/) - Typing protocols, aliases, generics, and shared type helpers for Tigrbl framework packages and extensions.
256
+ ## What It Owns
285
257
 
286
- Engine packages:
287
- - [`tigrbl_engine_bigquery`](https://pypi.org/project/tigrbl_engine_bigquery/) - BigQuery engine plugin for Google BigQuery warehouse sessions, analytics workloads, and Tigrbl engine registration.
288
- - [`tigrbl_engine_clickhouse`](https://pypi.org/project/tigrbl_engine_clickhouse/) - ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
289
- - [`tigrbl_engine_csv`](https://pypi.org/project/tigrbl_engine_csv/) - CSV engine plugin for file-backed tables, pandas DataFrames, and lightweight Tigrbl data workflows.
290
- - [`tigrbl_engine_dataframe`](https://pypi.org/project/tigrbl_engine_dataframe/) - DataFrame engine plugin for transactional pandas sessions and in-process Tigrbl analytics workloads.
291
- - [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/) - DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.
292
- - [`tigrbl_engine_inmemcache`](https://pypi.org/project/tigrbl_engine_inmemcache/) - In-memory cache engine plugin for process-local TTL, LRU, and fast Tigrbl cache workflows.
293
- - [`tigrbl_engine_inmemory`](https://pypi.org/project/tigrbl_engine_inmemory/) - In-memory database engine plugin for process-local transactional storage, copy-on-write snapshots, and Tigrbl testing.
294
- - [`tigrbl_engine_membloom`](https://pypi.org/project/tigrbl_engine_membloom/) - In-memory Bloom filter engine plugin for membership checks, rotating TTL windows, and Tigrbl API workflows.
295
- - [`tigrbl_engine_memdedupe`](https://pypi.org/project/tigrbl_engine_memdedupe/) - In-memory dedupe engine plugin for idempotency tracking, duplicate suppression, and Tigrbl workflow coordination.
296
- - [`tigrbl_engine_memkv`](https://pypi.org/project/tigrbl_engine_memkv/) - In-memory key-value engine plugin for process-local KV storage, cache workflows, and lightweight Tigrbl services.
297
- - [`tigrbl_engine_memlru`](https://pypi.org/project/tigrbl_engine_memlru/) - In-memory LRU engine plugin for least-recently-used cache behavior and process-local Tigrbl data workflows.
298
- - [`tigrbl_engine_mempubsub`](https://pypi.org/project/tigrbl_engine_mempubsub/) - In-memory pub/sub engine plugin for process-local publish-subscribe channels, events, and Tigrbl realtime workflows.
299
- - [`tigrbl_engine_memqueue`](https://pypi.org/project/tigrbl_engine_memqueue/) - In-memory queue engine plugin for process-local tasks, message workflows, and Tigrbl runtime coordination.
300
- - [`tigrbl_engine_memrate`](https://pypi.org/project/tigrbl_engine_memrate/) - In-memory rate-limit engine plugin for API quotas, counters, windows, and Tigrbl governance workflows.
301
- - [`tigrbl_engine_numpy`](https://pypi.org/project/tigrbl_engine_numpy/) - NumPy engine plugin for array-to-table helpers, analytical workflows, and Tigrbl data integration.
302
- - [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/) - Pandas engine plugin for transactional DataFrame sessions, tabular workflows, and Tigrbl data integration.
303
- - [`tigrbl_engine_pgsqli_wal`](https://pypi.org/project/tigrbl_engine_pgsqli_wal/) - PostgreSQL and SQLite WAL engine plugin for transactional Tigrbl workflows and database-backed engine registration.
304
- - [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/) - PostgreSQL engine plugin for SQLAlchemy sessions, async database workflows, and Tigrbl application persistence.
305
- - [`tigrbl_engine_pyspark`](https://pypi.org/project/tigrbl_engine_pyspark/) - PySpark engine plugin for distributed DataFrame integration, analytics workloads, and Tigrbl data workflows.
306
- - [`tigrbl_engine_redis`](https://pypi.org/project/tigrbl_engine_redis/) - Redis engine plugin for cache, data structures, and Tigrbl engine workflows backed by Redis.
307
- - [`tigrbl_engine_rediscachethrough`](https://pypi.org/project/tigrbl_engine_rediscachethrough/) - Redis cache-through engine plugin for Redis, PostgreSQL, and Tigrbl data-access acceleration workflows.
308
- - [`tigrbl_engine_snowflake`](https://pypi.org/project/tigrbl_engine_snowflake/) - Snowflake engine plugin for warehouse sessions, analytical workloads, and Tigrbl engine registration.
309
- - [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/) - SQLite engine plugin for SQLAlchemy sessions, local transactional storage, and Tigrbl application persistence.
310
- - [`tigrbl_engine_xlsx`](https://pypi.org/project/tigrbl_engine_xlsx/) - XLSX engine plugin for Excel workbook-backed tables, worksheet data access, and Tigrbl tabular workflows.
258
+ `tigrbl_spec` owns the spec boundary inside the split Python workspace.
311
259
 
312
- Application packages:
313
- - [`tigrbl_acme_ca`](https://pypi.org/project/tigrbl_acme_ca/) - ACME v2 certificate authority app for Tigrbl tables, certificate automation, TLS workflows, and API surfaces.
314
- - [`tigrbl_spiffe`](https://pypi.org/project/tigrbl_spiffe/) - SPIFFE and SPIRE identity app for Tigrbl with workload identity tables, UDS transport, and HTTP API surfaces.
260
+ ## Use It When
315
261
 
316
- Source-tree links remain available from each package identity section; this ecosystem section is intentionally PyPI-first for package discovery and installation routing.
262
+ Use `tigrbl_spec` when you want this subsystem directly as a package boundary instead of consuming it only through the top-level `tigrbl` facade.
317
263
 
318
- ## Install
264
+ ## Public Surface
319
265
 
320
- ```bash
321
- pip install tigrbl_spec
322
- ```
266
+ - `tigrbl_spec` exposes `__version__`.
323
267
 
324
- ## Package discovery
268
+ ## Internal Layout
325
269
 
326
- `tigrbl_spec` is described for package indexes, search engines, answer engines, and AI coding tools as: Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
270
+ - Workspace path: `pkgs/core/tigrbl_spec`.
271
+ - Package class: `core framework package`.
272
+ - Python requirement: `>=3.10,<3.15`.
327
273
 
328
- Use `tigrbl_spec` when you need Tigrbl's schema-first ASGI package graph for REST APIs, JSON-RPC APIs, OpenAPI documentation, OpenRPC documentation, SQLAlchemy-backed models, Pydantic validation, typed operation specs, runtime dispatch, and installable engine or application extensions.
274
+ ## Dependency Surface
329
275
 
330
- Discovery terms: tigrbl, ASGI, schema-first API framework, REST API, JSON-RPC API, OpenAPI documentation, OpenRPC documentation, SQLAlchemy models, Pydantic validation, typed validation, operation dispatch, engine plugins, api, json-rpc, rest, sqlalchemy, pydantic, spec, specification, protocols, compatibility, openapi, openrpc, schema-first.
276
+ - Workspace package dependencies: none declared.
277
+ - External runtime dependencies: none declared.
278
+ - Optional extras: none declared.
331
279
 
332
- ## Package-local entry point
280
+ ## Related Packages
333
281
 
334
- This file is a package-local distribution entry point.
335
- It is not the authoritative location for repository governance, current target status, current state reporting, certification claims, or release evidence.
282
+ - [`tigrbl`](https://pypi.org/project/tigrbl/)
336
283
 
337
- ## Canonical repository docs
284
+ ## Canonical Repository Docs
338
285
 
339
- - `README.md`
340
286
  - `docs/README.md`
341
287
  - `docs/conformance/CURRENT_TARGET.md`
342
288
  - `docs/conformance/CURRENT_STATE.md`
@@ -345,15 +291,12 @@ It is not the authoritative location for repository governance, current target s
345
291
  - `docs/developer/PACKAGE_CATALOG.md`
346
292
  - `docs/developer/PACKAGE_LAYOUT.md`
347
293
 
348
- ## Package identity
294
+ ## Package-local Boundary
295
+
296
+ This file is a package-local distribution entry point.
297
+ Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
349
298
 
350
- - canonical repository: `https://github.com/tigrbl/tigrbl`
351
- - organization: `https://github.com/tigrbl`
352
- - social: `https://discord.gg/K4YTAPapjR`
353
- - package path: `https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec`
354
- - workspace path: `pkgs/core/tigrbl_spec`
355
- - workspace class: core Python package
356
- - implementation layout: `tigrbl_spec/`
299
+ ## License
357
300
 
358
- Long-form repository documentation is governed from `docs/`.
301
+ Licensed under the Apache License, Version 2.0. See `LICENSE` and the official [Apache 2.0 license text](https://www.apache.org/licenses/LICENSE-2.0).
359
302
 
@@ -0,0 +1,68 @@
1
+ <div align="center">
2
+ <h1>tigrbl_spec</h1>
3
+ <img src="https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png" alt="Tigrbl logo" width="140"/>
4
+ <p><strong>Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.</strong></p>
5
+ <a href="https://pypi.org/project/tigrbl_spec/"><img src="https://img.shields.io/pypi/v/tigrbl_spec?label=PyPI" alt="PyPI version for tigrbl_spec"/></a>
6
+ <a href="https://pypi.org/project/tigrbl_spec/"><img src="https://static.pepy.tech/badge/tigrbl_spec" alt="Downloads for tigrbl_spec"/></a>
7
+ <a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_spec/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_spec/README.md.svg?label=hits" alt="Repository hits for tigrbl_spec README"/></a>
8
+ <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
9
+ <a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20to%203.15-3776ab" alt="Python requirement for tigrbl_spec"/></a>
10
+ <a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-core-1f6feb" alt="Workspace group for tigrbl_spec"/></a>
11
+ </div>
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ uv add tigrbl_spec
17
+ ```
18
+
19
+ ```bash
20
+ pip install tigrbl_spec
21
+ ```
22
+
23
+ ## What It Owns
24
+
25
+ `tigrbl_spec` owns the spec boundary inside the split Python workspace.
26
+
27
+ ## Use It When
28
+
29
+ Use `tigrbl_spec` when you want this subsystem directly as a package boundary instead of consuming it only through the top-level `tigrbl` facade.
30
+
31
+ ## Public Surface
32
+
33
+ - `tigrbl_spec` exposes `__version__`.
34
+
35
+ ## Internal Layout
36
+
37
+ - Workspace path: `pkgs/core/tigrbl_spec`.
38
+ - Package class: `core framework package`.
39
+ - Python requirement: `>=3.10,<3.15`.
40
+
41
+ ## Dependency Surface
42
+
43
+ - Workspace package dependencies: none declared.
44
+ - External runtime dependencies: none declared.
45
+ - Optional extras: none declared.
46
+
47
+ ## Related Packages
48
+
49
+ - [`tigrbl`](https://pypi.org/project/tigrbl/)
50
+
51
+ ## Canonical Repository Docs
52
+
53
+ - `docs/README.md`
54
+ - `docs/conformance/CURRENT_TARGET.md`
55
+ - `docs/conformance/CURRENT_STATE.md`
56
+ - `docs/conformance/NEXT_STEPS.md`
57
+ - `docs/governance/DOC_POINTERS.md`
58
+ - `docs/developer/PACKAGE_CATALOG.md`
59
+ - `docs/developer/PACKAGE_LAYOUT.md`
60
+
61
+ ## Package-local Boundary
62
+
63
+ This file is a package-local distribution entry point.
64
+ Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
65
+
66
+ ## License
67
+
68
+ Licensed under the Apache License, Version 2.0. See `LICENSE` and the official [Apache 2.0 license text](https://www.apache.org/licenses/LICENSE-2.0).
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "tigrbl_spec"
3
- version = "0.4.1.dev6"
3
+ version = "0.4.2.dev3"
4
4
  description = "Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration."
5
5
  readme = "README.md"
6
6
  license = { file = "LICENSE" }
@@ -1,125 +0,0 @@
1
- ![Tigrbl Logo](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png)
2
-
3
- <p align="center">
4
- <a href="https://pepy.tech/project/tigrbl_spec">
5
- <img src="https://static.pepy.tech/badge/tigrbl_spec" alt="Pepy downloads for tigrbl_spec"/></a>
6
- <a href="https://hits.sh/github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec/">
7
- <img src="https://hits.sh/github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec.svg" alt="Repository views for tigrbl_spec"/></a>
8
- <a href="https://pypi.org/project/tigrbl_spec/">
9
- <img src="https://img.shields.io/badge/python-3.10--3.14-blue" alt="Python 3.10 through 3.14"/></a>
10
- <a href="https://pypi.org/project/tigrbl_spec/">
11
- <img src="https://img.shields.io/pypi/l/tigrbl_spec" alt="PyPI license metadata for tigrbl_spec"/></a>
12
- <a href="https://pypi.org/project/tigrbl_spec/">
13
- <img src="https://img.shields.io/pypi/v/tigrbl_spec?label=tigrbl_spec&color=green" alt="PyPI version for tigrbl_spec"/></a>
14
- </p>
15
-
16
- ---
17
-
18
- <h1 align="center">Tigrbl spec</h1>
19
-
20
- **Inspect specification compatibility targets: [open `tigrbl_spec`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec).**
21
-
22
- tigrbl_spec is a specification package for shared interfaces, protocol definitions, compatibility targets, and specification artifacts for Tigrbl.
23
-
24
- `tigrbl_spec` is part of the Tigrbl package graph. It documents package-resident classes, concepts, extension points, and execution responsibilities while cross-linking to the facade, core specs, canonical mapping, runtime phases, concrete objects, operation packages, engine plugins, OpenAPI/OpenRPC documentation surfaces, and PyPI distributions that complete the system.
25
-
26
- ## Resident concepts
27
-
28
- - `tigrbl_spec` is the shared specification package for protocol definitions, compatibility targets, and planning-stage spec surfaces that are consumed by other Tigrbl packages.
29
- - Use this README for package-level spec guidance that is broader than one Python class but narrower than the governed repository docs.
30
-
31
- ## Package ecosystem cross-links
32
-
33
- Every Tigrbl Python package links to its sibling distributions on PyPI so package indexes, search engines, answer engines, dependency scanners, and human readers can move through the installable package graph without falling back to source-tree paths.
34
-
35
- Core packages:
36
- - [`tigrbl`](https://pypi.org/project/tigrbl/) - Schema-first ASGI API framework for REST, JSON-RPC, OpenAPI, OpenRPC, SQLAlchemy models, typed validation, lifecycle hooks, and engine plugins.
37
- - [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/) - Runtime atom utilities for Tigrbl planning, dispatch, transport ingress, egress, and high-throughput ASGI execution pipelines.
38
- - [`tigrbl-base`](https://pypi.org/project/tigrbl-base/) - Abstract base interfaces for Tigrbl APIs, engines, providers, sessions, transports, and reusable runtime components.
39
- - [`tigrbl-canon`](https://pypi.org/project/tigrbl-canon/) - Canonical mapping, routing, symbol resolution, and naming utilities for Tigrbl framework packages and generated API surfaces.
40
- - [`tigrbl_client`](https://pypi.org/project/tigrbl_client/) - Typed Python client helpers for calling Tigrbl REST, JSON-RPC, OpenAPI, and generated schema-first API surfaces.
41
- - [`tigrbl-concrete`](https://pypi.org/project/tigrbl-concrete/) - Concrete Tigrbl implementations for reusable framework behavior, sessions, routes, responses, and base abstraction adapters.
42
- - [`tigrbl-core`](https://pypi.org/project/tigrbl-core/) - Core Tigrbl framework specifications, decorators, schemas, hooks, operations, and primitives for schema-first APIs.
43
- - [`tigrbl-kernel`](https://pypi.org/project/tigrbl-kernel/) - Kernel orchestration for composing Tigrbl runtime plans, bindings, operation dispatch, and optimized ASGI execution.
44
- - [`tigrbl-ops-olap`](https://pypi.org/project/tigrbl-ops-olap/) - Analytical OLAP operation boundaries for Tigrbl workloads, query-oriented APIs, and engine integrations.
45
- - [`tigrbl-ops-oltp`](https://pypi.org/project/tigrbl-ops-oltp/) - Transactional OLTP operation handlers for Tigrbl CRUD, bulk, REST, JSON-RPC, and database-backed workloads.
46
- - [`tigrbl-ops-realtime`](https://pypi.org/project/tigrbl-ops-realtime/) - Realtime, streaming, datagram, websocket, and event operation handlers for Tigrbl ASGI runtimes.
47
- - [`tigrbl-orm`](https://pypi.org/project/tigrbl-orm/) - SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.
48
- - [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/) - Runtime pipeline helpers and execution bridge surfaces for Tigrbl ASGI applications, transports, and operation dispatch.
49
- - [`tigrbl_spec`](https://pypi.org/project/tigrbl_spec/) (this package) - Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
50
- - [`tigrbl_tests`](https://pypi.org/project/tigrbl_tests/) - Reusable Tigrbl pytest fixtures, conformance assertions, integration helpers, and package test utilities.
51
- - [`tigrbl-typing`](https://pypi.org/project/tigrbl-typing/) - Typing protocols, aliases, generics, and shared type helpers for Tigrbl framework packages and extensions.
52
-
53
- Engine packages:
54
- - [`tigrbl_engine_bigquery`](https://pypi.org/project/tigrbl_engine_bigquery/) - BigQuery engine plugin for Google BigQuery warehouse sessions, analytics workloads, and Tigrbl engine registration.
55
- - [`tigrbl_engine_clickhouse`](https://pypi.org/project/tigrbl_engine_clickhouse/) - ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
56
- - [`tigrbl_engine_csv`](https://pypi.org/project/tigrbl_engine_csv/) - CSV engine plugin for file-backed tables, pandas DataFrames, and lightweight Tigrbl data workflows.
57
- - [`tigrbl_engine_dataframe`](https://pypi.org/project/tigrbl_engine_dataframe/) - DataFrame engine plugin for transactional pandas sessions and in-process Tigrbl analytics workloads.
58
- - [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/) - DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.
59
- - [`tigrbl_engine_inmemcache`](https://pypi.org/project/tigrbl_engine_inmemcache/) - In-memory cache engine plugin for process-local TTL, LRU, and fast Tigrbl cache workflows.
60
- - [`tigrbl_engine_inmemory`](https://pypi.org/project/tigrbl_engine_inmemory/) - In-memory database engine plugin for process-local transactional storage, copy-on-write snapshots, and Tigrbl testing.
61
- - [`tigrbl_engine_membloom`](https://pypi.org/project/tigrbl_engine_membloom/) - In-memory Bloom filter engine plugin for membership checks, rotating TTL windows, and Tigrbl API workflows.
62
- - [`tigrbl_engine_memdedupe`](https://pypi.org/project/tigrbl_engine_memdedupe/) - In-memory dedupe engine plugin for idempotency tracking, duplicate suppression, and Tigrbl workflow coordination.
63
- - [`tigrbl_engine_memkv`](https://pypi.org/project/tigrbl_engine_memkv/) - In-memory key-value engine plugin for process-local KV storage, cache workflows, and lightweight Tigrbl services.
64
- - [`tigrbl_engine_memlru`](https://pypi.org/project/tigrbl_engine_memlru/) - In-memory LRU engine plugin for least-recently-used cache behavior and process-local Tigrbl data workflows.
65
- - [`tigrbl_engine_mempubsub`](https://pypi.org/project/tigrbl_engine_mempubsub/) - In-memory pub/sub engine plugin for process-local publish-subscribe channels, events, and Tigrbl realtime workflows.
66
- - [`tigrbl_engine_memqueue`](https://pypi.org/project/tigrbl_engine_memqueue/) - In-memory queue engine plugin for process-local tasks, message workflows, and Tigrbl runtime coordination.
67
- - [`tigrbl_engine_memrate`](https://pypi.org/project/tigrbl_engine_memrate/) - In-memory rate-limit engine plugin for API quotas, counters, windows, and Tigrbl governance workflows.
68
- - [`tigrbl_engine_numpy`](https://pypi.org/project/tigrbl_engine_numpy/) - NumPy engine plugin for array-to-table helpers, analytical workflows, and Tigrbl data integration.
69
- - [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/) - Pandas engine plugin for transactional DataFrame sessions, tabular workflows, and Tigrbl data integration.
70
- - [`tigrbl_engine_pgsqli_wal`](https://pypi.org/project/tigrbl_engine_pgsqli_wal/) - PostgreSQL and SQLite WAL engine plugin for transactional Tigrbl workflows and database-backed engine registration.
71
- - [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/) - PostgreSQL engine plugin for SQLAlchemy sessions, async database workflows, and Tigrbl application persistence.
72
- - [`tigrbl_engine_pyspark`](https://pypi.org/project/tigrbl_engine_pyspark/) - PySpark engine plugin for distributed DataFrame integration, analytics workloads, and Tigrbl data workflows.
73
- - [`tigrbl_engine_redis`](https://pypi.org/project/tigrbl_engine_redis/) - Redis engine plugin for cache, data structures, and Tigrbl engine workflows backed by Redis.
74
- - [`tigrbl_engine_rediscachethrough`](https://pypi.org/project/tigrbl_engine_rediscachethrough/) - Redis cache-through engine plugin for Redis, PostgreSQL, and Tigrbl data-access acceleration workflows.
75
- - [`tigrbl_engine_snowflake`](https://pypi.org/project/tigrbl_engine_snowflake/) - Snowflake engine plugin for warehouse sessions, analytical workloads, and Tigrbl engine registration.
76
- - [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/) - SQLite engine plugin for SQLAlchemy sessions, local transactional storage, and Tigrbl application persistence.
77
- - [`tigrbl_engine_xlsx`](https://pypi.org/project/tigrbl_engine_xlsx/) - XLSX engine plugin for Excel workbook-backed tables, worksheet data access, and Tigrbl tabular workflows.
78
-
79
- Application packages:
80
- - [`tigrbl_acme_ca`](https://pypi.org/project/tigrbl_acme_ca/) - ACME v2 certificate authority app for Tigrbl tables, certificate automation, TLS workflows, and API surfaces.
81
- - [`tigrbl_spiffe`](https://pypi.org/project/tigrbl_spiffe/) - SPIFFE and SPIRE identity app for Tigrbl with workload identity tables, UDS transport, and HTTP API surfaces.
82
-
83
- Source-tree links remain available from each package identity section; this ecosystem section is intentionally PyPI-first for package discovery and installation routing.
84
-
85
- ## Install
86
-
87
- ```bash
88
- pip install tigrbl_spec
89
- ```
90
-
91
- ## Package discovery
92
-
93
- `tigrbl_spec` is described for package indexes, search engines, answer engines, and AI coding tools as: Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
94
-
95
- Use `tigrbl_spec` when you need Tigrbl's schema-first ASGI package graph for REST APIs, JSON-RPC APIs, OpenAPI documentation, OpenRPC documentation, SQLAlchemy-backed models, Pydantic validation, typed operation specs, runtime dispatch, and installable engine or application extensions.
96
-
97
- Discovery terms: tigrbl, ASGI, schema-first API framework, REST API, JSON-RPC API, OpenAPI documentation, OpenRPC documentation, SQLAlchemy models, Pydantic validation, typed validation, operation dispatch, engine plugins, api, json-rpc, rest, sqlalchemy, pydantic, spec, specification, protocols, compatibility, openapi, openrpc, schema-first.
98
-
99
- ## Package-local entry point
100
-
101
- This file is a package-local distribution entry point.
102
- It is not the authoritative location for repository governance, current target status, current state reporting, certification claims, or release evidence.
103
-
104
- ## Canonical repository docs
105
-
106
- - `README.md`
107
- - `docs/README.md`
108
- - `docs/conformance/CURRENT_TARGET.md`
109
- - `docs/conformance/CURRENT_STATE.md`
110
- - `docs/conformance/NEXT_STEPS.md`
111
- - `docs/governance/DOC_POINTERS.md`
112
- - `docs/developer/PACKAGE_CATALOG.md`
113
- - `docs/developer/PACKAGE_LAYOUT.md`
114
-
115
- ## Package identity
116
-
117
- - canonical repository: `https://github.com/tigrbl/tigrbl`
118
- - organization: `https://github.com/tigrbl`
119
- - social: `https://discord.gg/K4YTAPapjR`
120
- - package path: `https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec`
121
- - workspace path: `pkgs/core/tigrbl_spec`
122
- - workspace class: core Python package
123
- - implementation layout: `tigrbl_spec/`
124
-
125
- Long-form repository documentation is governed from `docs/`.