tigrbl-base 0.4.2.dev3__tar.gz → 0.4.2.dev4__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.
- tigrbl_base-0.4.2.dev4/NOTICE +7 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/PKG-INFO +116 -27
- tigrbl_base-0.4.2.dev4/README.md +158 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/pyproject.toml +1 -1
- tigrbl_base-0.4.2.dev3/README.md +0 -70
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/LICENSE +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/__init__.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_alias_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_app_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_assembly.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_binding_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_column_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_datatype_lowering.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_engine_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_engine_provider_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_headers_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_hook_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_mapping_access.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_middleware_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_op_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_request_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_response_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_rest_map.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_router_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_rpc_map.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_schema_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_security_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_session_abc.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_session_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_storage.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_table_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_table_registry_base.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/__init__.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/__init__.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/core.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/jsonhints.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/planning.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/types.py +0 -0
- {tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/column/infer/utils.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: tigrbl-base
|
|
3
|
-
Version: 0.4.2.
|
|
3
|
+
Version: 0.4.2.dev4
|
|
4
4
|
Summary: Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.
|
|
5
5
|
License: Apache License
|
|
6
6
|
Version 2.0, January 2004
|
|
@@ -204,6 +204,7 @@ License: Apache License
|
|
|
204
204
|
See the License for the specific language governing permissions and
|
|
205
205
|
limitations under the License.
|
|
206
206
|
License-File: LICENSE
|
|
207
|
+
License-File: NOTICE
|
|
207
208
|
Keywords: tigrbl,asgi,api,abstract base classes,api contracts,base contracts,engine interfaces,framework internals,json-rpc,base,base-classes,interfaces,abstractions,openapi,openrpc,request response,rest,schema-first,session interfaces,sqlalchemy,table base
|
|
208
209
|
Author: Jacob Stewart
|
|
209
210
|
Author-email: jacob@swarmauri.com
|
|
@@ -246,12 +247,45 @@ Description-Content-Type: text/markdown
|
|
|
246
247
|
<p><strong>Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.</strong></p>
|
|
247
248
|
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://img.shields.io/pypi/v/tigrbl-base?label=PyPI" alt="PyPI version for tigrbl-base"/></a>
|
|
248
249
|
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://static.pepy.tech/badge/tigrbl-base" alt="Downloads for tigrbl-base"/></a>
|
|
250
|
+
<a href="https://discord.gg/K4YTAPapjR"><img src="https://img.shields.io/badge/Discord-Join%20chat-5865F2?logo=discord&logoColor=white" alt="Discord community for tigrbl-base"/></a>
|
|
249
251
|
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md.svg?label=hits" alt="Repository hits for tigrbl-base README"/></a>
|
|
250
252
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
|
|
251
|
-
<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%
|
|
253
|
+
<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-3776ab" alt="Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl-base"/></a>
|
|
252
254
|
<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-base"/></a>
|
|
253
255
|
</div>
|
|
254
256
|
|
|
257
|
+
## What is tigrbl-base?
|
|
258
|
+
|
|
259
|
+
Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.
|
|
260
|
+
|
|
261
|
+
## Why use tigrbl-base?
|
|
262
|
+
|
|
263
|
+
Use it when you need this foundational Tigrbl layer directly as a small, focused dependency.
|
|
264
|
+
|
|
265
|
+
## When should I install tigrbl-base?
|
|
266
|
+
|
|
267
|
+
Install it for extension packages, package-local tests, or internals that need this boundary without the whole facade.
|
|
268
|
+
|
|
269
|
+
## Who is tigrbl-base for?
|
|
270
|
+
|
|
271
|
+
Framework maintainers, extension authors, and advanced users composing Tigrbl from split packages.
|
|
272
|
+
|
|
273
|
+
## Where does tigrbl-base fit?
|
|
274
|
+
|
|
275
|
+
`tigrbl-base` lives at `pkgs/core/tigrbl_base` and serves a focused layer in the split Tigrbl framework.
|
|
276
|
+
|
|
277
|
+
## How does tigrbl-base work?
|
|
278
|
+
|
|
279
|
+
It owns a narrow layer in the split workspace and is consumed by higher-level packages through explicit dependencies.
|
|
280
|
+
|
|
281
|
+
## Certification Status
|
|
282
|
+
|
|
283
|
+
- Package status: governed package in the `tigrbl/tigrbl` workspace.
|
|
284
|
+
- Governance source: [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json).
|
|
285
|
+
- Release evidence: [publish workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml) validates package builds, tests, GitHub release assets, and PyPI publication for managed packages.
|
|
286
|
+
- 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`.
|
|
287
|
+
- Scope note: this README documents the package boundary. Runtime feature support remains governed by `.ssot/` entities and the conformance docs linked below.
|
|
288
|
+
|
|
255
289
|
## Install
|
|
256
290
|
|
|
257
291
|
```bash
|
|
@@ -262,52 +296,107 @@ uv add tigrbl-base
|
|
|
262
296
|
pip install tigrbl-base
|
|
263
297
|
```
|
|
264
298
|
|
|
299
|
+
## Surface Coverage
|
|
300
|
+
|
|
301
|
+
| Surface | Value |
|
|
302
|
+
|---|---|
|
|
303
|
+
| PyPI package | [`tigrbl-base`](https://pypi.org/project/tigrbl-base/) |
|
|
304
|
+
| Repository path | [`pkgs/core/tigrbl_base`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_base) |
|
|
305
|
+
| Python import root | `tigrbl_base` |
|
|
306
|
+
| Console scripts | none declared |
|
|
307
|
+
| Entry points | none declared |
|
|
308
|
+
| Optional extras | none declared |
|
|
309
|
+
| Legal files | `LICENSE`, `NOTICE` |
|
|
310
|
+
| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
|
|
311
|
+
|
|
265
312
|
## What It Owns
|
|
266
313
|
|
|
267
|
-
`tigrbl-base` owns the
|
|
314
|
+
`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.
|
|
315
|
+
|
|
316
|
+
Implementation orientation:
|
|
317
|
+
- `tigrbl_base`: _base/, column/
|
|
318
|
+
|
|
319
|
+
## Public API and Import Surface
|
|
268
320
|
|
|
269
|
-
|
|
321
|
+
- Import roots: `tigrbl_base`.
|
|
322
|
+
- Public symbols: public surface is module-oriented; import the package boundary and inspect submodules as needed.
|
|
323
|
+
- Workspace dependencies: [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/).
|
|
324
|
+
- External runtime dependencies: `sqlalchemy>=2.0`, `pydantic>=2.0`.
|
|
270
325
|
|
|
271
|
-
|
|
326
|
+
## Usage Examples
|
|
272
327
|
|
|
273
|
-
|
|
328
|
+
### Verify the installed package
|
|
274
329
|
|
|
275
|
-
|
|
330
|
+
```bash
|
|
331
|
+
python -m pip show tigrbl-base
|
|
332
|
+
python - <<'PY'
|
|
333
|
+
from importlib.metadata import version
|
|
334
|
+
print(version("tigrbl-base"))
|
|
335
|
+
PY
|
|
336
|
+
```
|
|
276
337
|
|
|
277
|
-
|
|
338
|
+
### Import the package boundary
|
|
278
339
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
- Python requirement: `>=3.10,<3.15`.
|
|
340
|
+
```python
|
|
341
|
+
import importlib
|
|
282
342
|
|
|
283
|
-
|
|
343
|
+
module = importlib.import_module("tigrbl_base._base")
|
|
344
|
+
print(module.__name__)
|
|
345
|
+
```
|
|
284
346
|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
347
|
+
### Inspect available modules
|
|
348
|
+
|
|
349
|
+
```python
|
|
350
|
+
import importlib
|
|
351
|
+
import pkgutil
|
|
352
|
+
|
|
353
|
+
module = importlib.import_module("tigrbl_base._base")
|
|
354
|
+
for info in pkgutil.iter_modules(getattr(module, "__path__", [])):
|
|
355
|
+
print(info.name)
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Use with the facade when building applications
|
|
359
|
+
|
|
360
|
+
```bash
|
|
361
|
+
uv add tigrbl tigrbl-base
|
|
362
|
+
python - <<'PY'
|
|
363
|
+
import tigrbl
|
|
364
|
+
print(tigrbl.__name__)
|
|
365
|
+
PY
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
## How To Choose This Package
|
|
369
|
+
|
|
370
|
+
Choose `tigrbl-base` when the quick-answer table matches your use case. Choose [`tigrbl`](https://pypi.org/project/tigrbl/) instead when you want the full public facade. Choose a lower-level package such as [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-base`](https://pypi.org/project/tigrbl-base/), or [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/) when you are building framework extensions or testing a specific internal boundary.
|
|
288
371
|
|
|
289
372
|
## Related Packages
|
|
290
373
|
|
|
291
|
-
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
292
374
|
- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
|
|
293
375
|
- [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/)
|
|
376
|
+
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
377
|
+
- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
|
|
378
|
+
|
|
379
|
+
## Documentation Links
|
|
380
|
+
|
|
381
|
+
- [Workspace docs](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
|
|
382
|
+
- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
|
|
383
|
+
- [Package layout](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_LAYOUT.md)
|
|
384
|
+
- [Current target](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_TARGET.md)
|
|
385
|
+
- [Current state](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_STATE.md)
|
|
386
|
+
- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
|
|
387
|
+
- [Release workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml)
|
|
294
388
|
|
|
295
|
-
##
|
|
389
|
+
## Support
|
|
296
390
|
|
|
297
|
-
-
|
|
298
|
-
-
|
|
299
|
-
-
|
|
300
|
-
- `docs/conformance/NEXT_STEPS.md`
|
|
301
|
-
- `docs/governance/DOC_POINTERS.md`
|
|
302
|
-
- `docs/developer/PACKAGE_CATALOG.md`
|
|
303
|
-
- `docs/developer/PACKAGE_LAYOUT.md`
|
|
391
|
+
- Community: [Discord](https://discord.gg/K4YTAPapjR).
|
|
392
|
+
- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
|
|
393
|
+
- Repository: [pkgs/core/tigrbl_base](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_base).
|
|
304
394
|
|
|
305
395
|
## Package-local Boundary
|
|
306
396
|
|
|
307
|
-
This
|
|
308
|
-
Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
|
|
397
|
+
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.
|
|
309
398
|
|
|
310
399
|
## License
|
|
311
400
|
|
|
312
|
-
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).
|
|
401
|
+
Licensed under the Apache License, Version 2.0. See `LICENSE`, `NOTICE`, and the official [Apache 2.0 license text](https://www.apache.org/licenses/LICENSE-2.0).
|
|
313
402
|
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1>tigrbl-base</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>Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.</strong></p>
|
|
5
|
+
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://img.shields.io/pypi/v/tigrbl-base?label=PyPI" alt="PyPI version for tigrbl-base"/></a>
|
|
6
|
+
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://static.pepy.tech/badge/tigrbl-base" alt="Downloads for tigrbl-base"/></a>
|
|
7
|
+
<a href="https://discord.gg/K4YTAPapjR"><img src="https://img.shields.io/badge/Discord-Join%20chat-5865F2?logo=discord&logoColor=white" alt="Discord community for tigrbl-base"/></a>
|
|
8
|
+
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md.svg?label=hits" alt="Repository hits for tigrbl-base README"/></a>
|
|
9
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
|
|
10
|
+
<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-3776ab" alt="Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl-base"/></a>
|
|
11
|
+
<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-base"/></a>
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
## What is tigrbl-base?
|
|
15
|
+
|
|
16
|
+
Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.
|
|
17
|
+
|
|
18
|
+
## Why use tigrbl-base?
|
|
19
|
+
|
|
20
|
+
Use it when you need this foundational Tigrbl layer directly as a small, focused dependency.
|
|
21
|
+
|
|
22
|
+
## When should I install tigrbl-base?
|
|
23
|
+
|
|
24
|
+
Install it for extension packages, package-local tests, or internals that need this boundary without the whole facade.
|
|
25
|
+
|
|
26
|
+
## Who is tigrbl-base for?
|
|
27
|
+
|
|
28
|
+
Framework maintainers, extension authors, and advanced users composing Tigrbl from split packages.
|
|
29
|
+
|
|
30
|
+
## Where does tigrbl-base fit?
|
|
31
|
+
|
|
32
|
+
`tigrbl-base` lives at `pkgs/core/tigrbl_base` and serves a focused layer in the split Tigrbl framework.
|
|
33
|
+
|
|
34
|
+
## How does tigrbl-base work?
|
|
35
|
+
|
|
36
|
+
It owns a narrow layer in the split workspace and is consumed by higher-level packages through explicit dependencies.
|
|
37
|
+
|
|
38
|
+
## Certification Status
|
|
39
|
+
|
|
40
|
+
- Package status: governed package in the `tigrbl/tigrbl` workspace.
|
|
41
|
+
- Governance source: [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json).
|
|
42
|
+
- Release evidence: [publish workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml) validates package builds, tests, GitHub release assets, and PyPI publication for managed packages.
|
|
43
|
+
- 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`.
|
|
44
|
+
- Scope note: this README documents the package boundary. Runtime feature support remains governed by `.ssot/` entities and the conformance docs linked below.
|
|
45
|
+
|
|
46
|
+
## Install
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
uv add tigrbl-base
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pip install tigrbl-base
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Surface Coverage
|
|
57
|
+
|
|
58
|
+
| Surface | Value |
|
|
59
|
+
|---|---|
|
|
60
|
+
| PyPI package | [`tigrbl-base`](https://pypi.org/project/tigrbl-base/) |
|
|
61
|
+
| Repository path | [`pkgs/core/tigrbl_base`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_base) |
|
|
62
|
+
| Python import root | `tigrbl_base` |
|
|
63
|
+
| Console scripts | none declared |
|
|
64
|
+
| Entry points | none declared |
|
|
65
|
+
| Optional extras | none declared |
|
|
66
|
+
| Legal files | `LICENSE`, `NOTICE` |
|
|
67
|
+
| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
|
|
68
|
+
|
|
69
|
+
## What It Owns
|
|
70
|
+
|
|
71
|
+
`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.
|
|
72
|
+
|
|
73
|
+
Implementation orientation:
|
|
74
|
+
- `tigrbl_base`: _base/, column/
|
|
75
|
+
|
|
76
|
+
## Public API and Import Surface
|
|
77
|
+
|
|
78
|
+
- Import roots: `tigrbl_base`.
|
|
79
|
+
- Public symbols: public surface is module-oriented; import the package boundary and inspect submodules as needed.
|
|
80
|
+
- Workspace dependencies: [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/).
|
|
81
|
+
- External runtime dependencies: `sqlalchemy>=2.0`, `pydantic>=2.0`.
|
|
82
|
+
|
|
83
|
+
## Usage Examples
|
|
84
|
+
|
|
85
|
+
### Verify the installed package
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
python -m pip show tigrbl-base
|
|
89
|
+
python - <<'PY'
|
|
90
|
+
from importlib.metadata import version
|
|
91
|
+
print(version("tigrbl-base"))
|
|
92
|
+
PY
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Import the package boundary
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
import importlib
|
|
99
|
+
|
|
100
|
+
module = importlib.import_module("tigrbl_base._base")
|
|
101
|
+
print(module.__name__)
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Inspect available modules
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
import importlib
|
|
108
|
+
import pkgutil
|
|
109
|
+
|
|
110
|
+
module = importlib.import_module("tigrbl_base._base")
|
|
111
|
+
for info in pkgutil.iter_modules(getattr(module, "__path__", [])):
|
|
112
|
+
print(info.name)
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Use with the facade when building applications
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
uv add tigrbl tigrbl-base
|
|
119
|
+
python - <<'PY'
|
|
120
|
+
import tigrbl
|
|
121
|
+
print(tigrbl.__name__)
|
|
122
|
+
PY
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## How To Choose This Package
|
|
126
|
+
|
|
127
|
+
Choose `tigrbl-base` when the quick-answer table matches your use case. Choose [`tigrbl`](https://pypi.org/project/tigrbl/) instead when you want the full public facade. Choose a lower-level package such as [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-base`](https://pypi.org/project/tigrbl-base/), or [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/) when you are building framework extensions or testing a specific internal boundary.
|
|
128
|
+
|
|
129
|
+
## Related Packages
|
|
130
|
+
|
|
131
|
+
- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
|
|
132
|
+
- [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/)
|
|
133
|
+
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
134
|
+
- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
|
|
135
|
+
|
|
136
|
+
## Documentation Links
|
|
137
|
+
|
|
138
|
+
- [Workspace docs](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
|
|
139
|
+
- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
|
|
140
|
+
- [Package layout](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_LAYOUT.md)
|
|
141
|
+
- [Current target](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_TARGET.md)
|
|
142
|
+
- [Current state](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_STATE.md)
|
|
143
|
+
- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
|
|
144
|
+
- [Release workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml)
|
|
145
|
+
|
|
146
|
+
## Support
|
|
147
|
+
|
|
148
|
+
- Community: [Discord](https://discord.gg/K4YTAPapjR).
|
|
149
|
+
- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
|
|
150
|
+
- Repository: [pkgs/core/tigrbl_base](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl_base).
|
|
151
|
+
|
|
152
|
+
## Package-local Boundary
|
|
153
|
+
|
|
154
|
+
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.
|
|
155
|
+
|
|
156
|
+
## License
|
|
157
|
+
|
|
158
|
+
Licensed under the Apache License, Version 2.0. See `LICENSE`, `NOTICE`, 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-base"
|
|
3
|
-
version = "0.4.2.
|
|
3
|
+
version = "0.4.2.dev4"
|
|
4
4
|
description = "Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = { file = "LICENSE" }
|
tigrbl_base-0.4.2.dev3/README.md
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
<h1>tigrbl-base</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>Base contract package for Tigrbl apps, routers, tables, sessions, middleware, requests, responses, bindings, and engine interfaces.</strong></p>
|
|
5
|
-
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://img.shields.io/pypi/v/tigrbl-base?label=PyPI" alt="PyPI version for tigrbl-base"/></a>
|
|
6
|
-
<a href="https://pypi.org/project/tigrbl-base/"><img src="https://static.pepy.tech/badge/tigrbl-base" alt="Downloads for tigrbl-base"/></a>
|
|
7
|
-
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl_base/README.md.svg?label=hits" alt="Repository hits for tigrbl-base 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-base"/></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-base"/></a>
|
|
11
|
-
</div>
|
|
12
|
-
|
|
13
|
-
## Install
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
uv add tigrbl-base
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
pip install tigrbl-base
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## What It Owns
|
|
24
|
-
|
|
25
|
-
`tigrbl-base` owns the base boundary inside the split Python workspace.
|
|
26
|
-
|
|
27
|
-
## Use It When
|
|
28
|
-
|
|
29
|
-
Use `tigrbl-base` 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
|
-
- Package-local implementation lives under `pkgs/core/tigrbl_base` and is consumed as a distribution boundary rather than a single broad root re-export.
|
|
34
|
-
|
|
35
|
-
## Internal Layout
|
|
36
|
-
|
|
37
|
-
- Workspace path: `pkgs/core/tigrbl_base`.
|
|
38
|
-
- Package class: `core framework package`.
|
|
39
|
-
- Python requirement: `>=3.10,<3.15`.
|
|
40
|
-
|
|
41
|
-
## Dependency Surface
|
|
42
|
-
|
|
43
|
-
- Workspace package dependencies: [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/).
|
|
44
|
-
- External runtime dependencies: `sqlalchemy>=2.0`, `pydantic>=2.0`.
|
|
45
|
-
- Optional extras: none declared.
|
|
46
|
-
|
|
47
|
-
## Related Packages
|
|
48
|
-
|
|
49
|
-
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
50
|
-
- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
|
|
51
|
-
- [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/)
|
|
52
|
-
|
|
53
|
-
## Canonical Repository Docs
|
|
54
|
-
|
|
55
|
-
- `docs/README.md`
|
|
56
|
-
- `docs/conformance/CURRENT_TARGET.md`
|
|
57
|
-
- `docs/conformance/CURRENT_STATE.md`
|
|
58
|
-
- `docs/conformance/NEXT_STEPS.md`
|
|
59
|
-
- `docs/governance/DOC_POINTERS.md`
|
|
60
|
-
- `docs/developer/PACKAGE_CATALOG.md`
|
|
61
|
-
- `docs/developer/PACKAGE_LAYOUT.md`
|
|
62
|
-
|
|
63
|
-
## Package-local Boundary
|
|
64
|
-
|
|
65
|
-
This file is a package-local distribution entry point.
|
|
66
|
-
Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
|
|
67
|
-
|
|
68
|
-
## License
|
|
69
|
-
|
|
70
|
-
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).
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{tigrbl_base-0.4.2.dev3 → tigrbl_base-0.4.2.dev4}/tigrbl_base/_base/_engine_provider_base.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|