tigrbl_spec 0.4.0.dev2__tar.gz → 0.4.1.dev6__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.
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright [2025] [Jacob Stewart @ Swarmauri]
189
+ Copyright [yyyy] [name of copyright owner]
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
@@ -0,0 +1,359 @@
1
+ Metadata-Version: 2.4
2
+ Name: tigrbl_spec
3
+ Version: 0.4.1.dev6
4
+ Summary: Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration.
5
+ License: Apache License
6
+ Version 2.0, January 2004
7
+ http://www.apache.org/licenses/
8
+
9
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
10
+
11
+ 1. Definitions.
12
+
13
+ "License" shall mean the terms and conditions for use, reproduction,
14
+ and distribution as defined by Sections 1 through 9 of this document.
15
+
16
+ "Licensor" shall mean the copyright owner or entity authorized by
17
+ the copyright owner that is granting the License.
18
+
19
+ "Legal Entity" shall mean the union of the acting entity and all
20
+ other entities that control, are controlled by, or are under common
21
+ control with that entity. For the purposes of this definition,
22
+ "control" means (i) the power, direct or indirect, to cause the
23
+ direction or management of such entity, whether by contract or
24
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
25
+ outstanding shares, or (iii) beneficial ownership of such entity.
26
+
27
+ "You" (or "Your") shall mean an individual or Legal Entity
28
+ exercising permissions granted by this License.
29
+
30
+ "Source" form shall mean the preferred form for making modifications,
31
+ including but not limited to software source code, documentation
32
+ source, and configuration files.
33
+
34
+ "Object" form shall mean any form resulting from mechanical
35
+ transformation or translation of a Source form, including but
36
+ not limited to compiled object code, generated documentation,
37
+ and conversions to other media types.
38
+
39
+ "Work" shall mean the work of authorship, whether in Source or
40
+ Object form, made available under the License, as indicated by a
41
+ copyright notice that is included in or attached to the work
42
+ (an example is provided in the Appendix below).
43
+
44
+ "Derivative Works" shall mean any work, whether in Source or Object
45
+ form, that is based on (or derived from) the Work and for which the
46
+ editorial revisions, annotations, elaborations, or other modifications
47
+ represent, as a whole, an original work of authorship. For the purposes
48
+ of this License, Derivative Works shall not include works that remain
49
+ separable from, or merely link (or bind by name) to the interfaces of,
50
+ the Work and Derivative Works thereof.
51
+
52
+ "Contribution" shall mean any work of authorship, including
53
+ the original version of the Work and any modifications or additions
54
+ to that Work or Derivative Works thereof, that is intentionally
55
+ submitted to Licensor for inclusion in the Work by the copyright owner
56
+ or by an individual or Legal Entity authorized to submit on behalf of
57
+ the copyright owner. For the purposes of this definition, "submitted"
58
+ means any form of electronic, verbal, or written communication sent
59
+ to the Licensor or its representatives, including but not limited to
60
+ communication on electronic mailing lists, source code control systems,
61
+ and issue tracking systems that are managed by, or on behalf of, the
62
+ Licensor for the purpose of discussing and improving the Work, but
63
+ excluding communication that is conspicuously marked or otherwise
64
+ designated in writing by the copyright owner as "Not a Contribution."
65
+
66
+ "Contributor" shall mean Licensor and any individual or Legal Entity
67
+ on behalf of whom a Contribution has been received by Licensor and
68
+ subsequently incorporated within the Work.
69
+
70
+ 2. Grant of Copyright License. Subject to the terms and conditions of
71
+ this License, each Contributor hereby grants to You a perpetual,
72
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
73
+ copyright license to reproduce, prepare Derivative Works of,
74
+ publicly display, publicly perform, sublicense, and distribute the
75
+ Work and such Derivative Works in Source or Object form.
76
+
77
+ 3. Grant of Patent License. Subject to the terms and conditions of
78
+ this License, each Contributor hereby grants to You a perpetual,
79
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
80
+ (except as stated in this section) patent license to make, have made,
81
+ use, offer to sell, sell, import, and otherwise transfer the Work,
82
+ where such license applies only to those patent claims licensable
83
+ by such Contributor that are necessarily infringed by their
84
+ Contribution(s) alone or by combination of their Contribution(s)
85
+ with the Work to which such Contribution(s) was submitted. If You
86
+ institute patent litigation against any entity (including a
87
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
88
+ or a Contribution incorporated within the Work constitutes direct
89
+ or contributory patent infringement, then any patent licenses
90
+ granted to You under this License for that Work shall terminate
91
+ as of the date such litigation is filed.
92
+
93
+ 4. Redistribution. You may reproduce and distribute copies of the
94
+ Work or Derivative Works thereof in any medium, with or without
95
+ modifications, and in Source or Object form, provided that You
96
+ meet the following conditions:
97
+
98
+ (a) You must give any other recipients of the Work or
99
+ Derivative Works a copy of this License; and
100
+
101
+ (b) You must cause any modified files to carry prominent notices
102
+ stating that You changed the files; and
103
+
104
+ (c) You must retain, in the Source form of any Derivative Works
105
+ that You distribute, all copyright, patent, trademark, and
106
+ attribution notices from the Source form of the Work,
107
+ excluding those notices that do not pertain to any part of
108
+ the Derivative Works; and
109
+
110
+ (d) If the Work includes a "NOTICE" text file as part of its
111
+ distribution, then any Derivative Works that You distribute must
112
+ include a readable copy of the attribution notices contained
113
+ within such NOTICE file, excluding those notices that do not
114
+ pertain to any part of the Derivative Works, in at least one
115
+ of the following places: within a NOTICE text file distributed
116
+ as part of the Derivative Works; within the Source form or
117
+ documentation, if provided along with the Derivative Works; or,
118
+ within a display generated by the Derivative Works, if and
119
+ wherever such third-party notices normally appear. The contents
120
+ of the NOTICE file are for informational purposes only and
121
+ do not modify the License. You may add Your own attribution
122
+ notices within Derivative Works that You distribute, alongside
123
+ or as an addendum to the NOTICE text from the Work, provided
124
+ that such additional attribution notices cannot be construed
125
+ as modifying the License.
126
+
127
+ You may add Your own copyright statement to Your modifications and
128
+ may provide additional or different license terms and conditions
129
+ for use, reproduction, or distribution of Your modifications, or
130
+ for any such Derivative Works as a whole, provided Your use,
131
+ reproduction, and distribution of the Work otherwise complies with
132
+ the conditions stated in this License.
133
+
134
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
135
+ any Contribution intentionally submitted for inclusion in the Work
136
+ by You to the Licensor shall be under the terms and conditions of
137
+ this License, without any additional terms or conditions.
138
+ Notwithstanding the above, nothing herein shall supersede or modify
139
+ the terms of any separate license agreement you may have executed
140
+ with Licensor regarding such Contributions.
141
+
142
+ 6. Trademarks. This License does not grant permission to use the trade
143
+ names, trademarks, service marks, or product names of the Licensor,
144
+ except as required for reasonable and customary use in describing the
145
+ origin of the Work and reproducing the content of the NOTICE file.
146
+
147
+ 7. Disclaimer of Warranty. Unless required by applicable law or
148
+ agreed to in writing, Licensor provides the Work (and each
149
+ Contributor provides its Contributions) on an "AS IS" BASIS,
150
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
151
+ implied, including, without limitation, any warranties or conditions
152
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
153
+ PARTICULAR PURPOSE. You are solely responsible for determining the
154
+ appropriateness of using or redistributing the Work and assume any
155
+ risks associated with Your exercise of permissions under this License.
156
+
157
+ 8. Limitation of Liability. In no event and under no legal theory,
158
+ whether in tort (including negligence), contract, or otherwise,
159
+ unless required by applicable law (such as deliberate and grossly
160
+ negligent acts) or agreed to in writing, shall any Contributor be
161
+ liable to You for damages, including any direct, indirect, special,
162
+ incidental, or consequential damages of any character arising as a
163
+ result of this License or out of the use or inability to use the
164
+ Work (including but not limited to damages for loss of goodwill,
165
+ work stoppage, computer failure or malfunction, or any and all
166
+ other commercial damages or losses), even if such Contributor
167
+ has been advised of the possibility of such damages.
168
+
169
+ 9. Accepting Warranty or Additional Liability. While redistributing
170
+ the Work or Derivative Works thereof, You may choose to offer,
171
+ and charge a fee for, acceptance of support, warranty, indemnity,
172
+ or other liability obligations and/or rights consistent with this
173
+ License. However, in accepting such obligations, You may act only
174
+ on Your own behalf and on Your sole responsibility, not on behalf
175
+ of any other Contributor, and only if You agree to indemnify,
176
+ defend, and hold each Contributor harmless for any liability
177
+ incurred by, or claims asserted against, such Contributor by reason
178
+ of your accepting any such warranty or additional liability.
179
+
180
+ END OF TERMS AND CONDITIONS
181
+
182
+ APPENDIX: How to apply the Apache License to your work.
183
+
184
+ To apply the Apache License to your work, attach the following
185
+ boilerplate notice, with the fields enclosed by brackets "[]"
186
+ replaced with your own identifying information. (Don't include
187
+ the brackets!) The text should be enclosed in the appropriate
188
+ comment syntax for the file format. We also recommend that a
189
+ file or class name and description of purpose be included on the
190
+ same "printed page" as the copyright notice for easier
191
+ identification within third-party archives.
192
+
193
+ Copyright [yyyy] [name of copyright owner]
194
+
195
+ Licensed under the Apache License, Version 2.0 (the "License");
196
+ you may not use this file except in compliance with the License.
197
+ You may obtain a copy of the License at
198
+
199
+ http://www.apache.org/licenses/LICENSE-2.0
200
+
201
+ Unless required by applicable law or agreed to in writing, software
202
+ distributed under the License is distributed on an "AS IS" BASIS,
203
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
204
+ See the License for the specific language governing permissions and
205
+ limitations under the License.
206
+ License-File: LICENSE
207
+ Keywords: tigrbl,asgi,api,json-rpc,rest,sqlalchemy,pydantic,spec,specification,protocols,compatibility,openapi,openrpc,schema-first
208
+ Author: Jacob Stewart
209
+ Author-email: jacob@swarmauri.com
210
+ Requires-Python: >=3.10,<3.15
211
+ Classifier: Development Status :: 3 - Alpha
212
+ Classifier: Intended Audience :: Developers
213
+ Classifier: Intended Audience :: Information Technology
214
+ Classifier: Framework :: AsyncIO
215
+ Classifier: Operating System :: OS Independent
216
+ Classifier: Programming Language :: Python
217
+ Classifier: Programming Language :: Python :: 3
218
+ Classifier: Programming Language :: Python :: 3 :: Only
219
+ Classifier: Programming Language :: Python :: 3.10
220
+ Classifier: Programming Language :: Python :: 3.11
221
+ Classifier: Programming Language :: Python :: 3.12
222
+ Classifier: Programming Language :: Python :: 3.13
223
+ Classifier: Programming Language :: Python :: 3.14
224
+ Classifier: Topic :: Internet :: WWW/HTTP
225
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
226
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
227
+ Project-URL: Discord, https://discord.gg/K4YTAPapjR
228
+ Project-URL: Homepage, https://github.com/tigrbl/tigrbl
229
+ Project-URL: Issues, https://github.com/tigrbl/tigrbl/issues
230
+ Project-URL: Organization, https://github.com/tigrbl
231
+ Project-URL: Repository, https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec
232
+ Description-Content-Type: text/markdown
233
+
234
+ ![Tigrbl Logo](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png)
235
+
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.
263
+
264
+ ## Package ecosystem cross-links
265
+
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.
267
+
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.
285
+
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.
311
+
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.
315
+
316
+ Source-tree links remain available from each package identity section; this ecosystem section is intentionally PyPI-first for package discovery and installation routing.
317
+
318
+ ## Install
319
+
320
+ ```bash
321
+ pip install tigrbl_spec
322
+ ```
323
+
324
+ ## Package discovery
325
+
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.
327
+
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.
329
+
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.
331
+
332
+ ## Package-local entry point
333
+
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.
336
+
337
+ ## Canonical repository docs
338
+
339
+ - `README.md`
340
+ - `docs/README.md`
341
+ - `docs/conformance/CURRENT_TARGET.md`
342
+ - `docs/conformance/CURRENT_STATE.md`
343
+ - `docs/conformance/NEXT_STEPS.md`
344
+ - `docs/governance/DOC_POINTERS.md`
345
+ - `docs/developer/PACKAGE_CATALOG.md`
346
+ - `docs/developer/PACKAGE_LAYOUT.md`
347
+
348
+ ## Package identity
349
+
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/`
357
+
358
+ Long-form repository documentation is governed from `docs/`.
359
+
@@ -0,0 +1,125 @@
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/`.
@@ -1,24 +1,47 @@
1
1
  [project]
2
2
  name = "tigrbl_spec"
3
- version = "0.4.0.dev2"
4
- description = "Planning-stage Tigrbl specification package for shared interfaces, protocol definitions, and compatibility targets."
5
- license = "Apache-2.0"
3
+ version = "0.4.1.dev6"
4
+ description = "Shared Tigrbl interfaces, protocol definitions, compatibility targets, and specification artifacts for framework integration."
6
5
  readme = "README.md"
7
- requires-python = ">=3.10,<3.14"
6
+ license = { file = "LICENSE" }
7
+ keywords = [
8
+ "tigrbl",
9
+ "asgi",
10
+ "api",
11
+ "json-rpc",
12
+ "rest",
13
+ "sqlalchemy",
14
+ "pydantic",
15
+ "spec",
16
+ "specification",
17
+ "protocols",
18
+ "compatibility",
19
+ "openapi",
20
+ "openrpc",
21
+ "schema-first",
22
+ ]
8
23
  classifiers = [
9
- "Development Status :: 1 - Planning",
24
+ "Development Status :: 3 - Alpha",
25
+ "Intended Audience :: Developers",
26
+ "Intended Audience :: Information Technology",
27
+ "Framework :: AsyncIO",
28
+ "Operating System :: OS Independent",
29
+ "Programming Language :: Python",
30
+ "Programming Language :: Python :: 3",
31
+ "Programming Language :: Python :: 3 :: Only",
10
32
  "Programming Language :: Python :: 3.10",
11
33
  "Programming Language :: Python :: 3.11",
12
34
  "Programming Language :: Python :: 3.12",
13
35
  "Programming Language :: Python :: 3.13",
14
- "Programming Language :: Python",
15
- "Programming Language :: Python :: 3",
16
- "Programming Language :: Python :: 3 :: Only",
36
+ "Programming Language :: Python :: 3.14",
37
+ "Topic :: Internet :: WWW/HTTP",
38
+ "Topic :: Software Development :: Libraries :: Application Frameworks",
39
+ "Topic :: Software Development :: Libraries :: Python Modules",
17
40
  ]
41
+ requires-python = ">=3.10,<3.15"
18
42
  authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
19
43
 
20
44
  dependencies = []
21
- keywords = ["tigrbl", "spec", "sdk", "standards", "planning"]
22
45
 
23
46
 
24
47
  [project.urls]
@@ -1,53 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: tigrbl_spec
3
- Version: 0.4.0.dev2
4
- Summary: Planning-stage Tigrbl specification package for shared interfaces, protocol definitions, and compatibility targets.
5
- License-Expression: Apache-2.0
6
- License-File: LICENSE
7
- Keywords: tigrbl,spec,sdk,standards,planning
8
- Author: Jacob Stewart
9
- Author-email: jacob@swarmauri.com
10
- Requires-Python: >=3.10,<3.14
11
- Classifier: Development Status :: 1 - Planning
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Classifier: Programming Language :: Python :: 3.13
16
- Classifier: Programming Language :: Python
17
- Classifier: Programming Language :: Python :: 3
18
- Classifier: Programming Language :: Python :: 3 :: Only
19
- Project-URL: Discord, https://discord.gg/K4YTAPapjR
20
- Project-URL: Homepage, https://github.com/tigrbl/tigrbl
21
- Project-URL: Issues, https://github.com/tigrbl/tigrbl/issues
22
- Project-URL: Organization, https://github.com/tigrbl
23
- Project-URL: Repository, https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec
24
- Description-Content-Type: text/markdown
25
-
26
- # tigrbl_spec
27
-
28
- This file is a package-local distribution entry point.
29
- It is not the authoritative location for repository governance, current target status, current state reporting, certification claims, or release evidence.
30
-
31
- ## Canonical repository docs
32
-
33
- - `README.md`
34
- - `docs/README.md`
35
- - `docs/conformance/CURRENT_TARGET.md`
36
- - `docs/conformance/CURRENT_STATE.md`
37
- - `docs/conformance/NEXT_STEPS.md`
38
- - `docs/governance/DOC_POINTERS.md`
39
- - `docs/developer/PACKAGE_CATALOG.md`
40
- - `docs/developer/PACKAGE_LAYOUT.md`
41
-
42
- ## Package identity
43
-
44
- - canonical repository: `https://github.com/tigrbl/tigrbl`
45
- - organization: `https://github.com/tigrbl`
46
- - social: `https://discord.gg/K4YTAPapjR`
47
- - package path: `https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec`
48
- - workspace path: `pkgs/core/tigrbl_spec`
49
- - workspace class: core Python package
50
- - implementation layout: `tigrbl_spec/`
51
-
52
- Long-form repository documentation is governed from `docs/`.
53
-
@@ -1,27 +0,0 @@
1
- # tigrbl_spec
2
-
3
- This file is a package-local distribution entry point.
4
- It is not the authoritative location for repository governance, current target status, current state reporting, certification claims, or release evidence.
5
-
6
- ## Canonical repository docs
7
-
8
- - `README.md`
9
- - `docs/README.md`
10
- - `docs/conformance/CURRENT_TARGET.md`
11
- - `docs/conformance/CURRENT_STATE.md`
12
- - `docs/conformance/NEXT_STEPS.md`
13
- - `docs/governance/DOC_POINTERS.md`
14
- - `docs/developer/PACKAGE_CATALOG.md`
15
- - `docs/developer/PACKAGE_LAYOUT.md`
16
-
17
- ## Package identity
18
-
19
- - canonical repository: `https://github.com/tigrbl/tigrbl`
20
- - organization: `https://github.com/tigrbl`
21
- - social: `https://discord.gg/K4YTAPapjR`
22
- - package path: `https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_spec`
23
- - workspace path: `pkgs/core/tigrbl_spec`
24
- - workspace class: core Python package
25
- - implementation layout: `tigrbl_spec/`
26
-
27
- Long-form repository documentation is governed from `docs/`.