tigrbl 0.4.2.dev3__py3-none-any.whl → 0.4.2.dev4__py3-none-any.whl

{tigrbl-0.4.2.dev3.dist-info → tigrbl-0.4.2.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tigrbl
-Version: 0.4.2.dev3
+Version: 0.4.2.dev4
 Summary: Schema-first ASGI framework for REST and JSON-RPC APIs with OpenAPI, OpenRPC, SQLAlchemy, typed validation, hooks, and engine plugins.
 License: Apache License
                                     Version 2.0, January 2004
@@ -204,6 +204,7 @@ License: Apache License
             See the License for the specific language governing permissions and
             limitations under the License.
 License-File: LICENSE
+License-File: NOTICE
 Keywords: tigrbl,asgi,api,api framework,asgi framework,dependency injection,fastapi alternative,json-rpc,framework,openapi,openrpc,pydantic,rest,schema-first,sqlalchemy,typed validation
 Author: Jacob Stewart
 Author-email: jacob@swarmauri.com
@@ -267,12 +268,45 @@ Description-Content-Type: text/markdown
 <p><strong>Schema-first ASGI framework for REST and JSON-RPC APIs with OpenAPI, OpenRPC, SQLAlchemy, typed validation, hooks, and engine plugins.</strong></p>
 <a href="https://pypi.org/project/tigrbl/"><img src="https://img.shields.io/pypi/v/tigrbl?label=PyPI" alt="PyPI version for tigrbl"/></a>
 <a href="https://pypi.org/project/tigrbl/"><img src="https://static.pepy.tech/badge/tigrbl" alt="Downloads for tigrbl"/></a>
+<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"/></a>
 <a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/core/tigrbl/README.md.svg?label=hits" alt="Repository hits for tigrbl README"/></a>
 <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
-<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20to%203.15-3776ab" alt="Python requirement for tigrbl"/></a>
+<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"/></a>
 <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"/></a>
 </div>
 
+## What is tigrbl?
+
+Schema-first ASGI framework for REST and JSON-RPC APIs with OpenAPI, OpenRPC, SQLAlchemy, typed validation, hooks, and engine plugins.
+
+## Why use tigrbl?
+
+Use it when you want the public Tigrbl authoring surface in one install target instead of composing split packages by hand.
+
+## When should I install tigrbl?
+
+Install it for application projects, examples, service skeletons, and teams that want REST, JSON-RPC, docs, schemas, engines, and CLI support from one facade.
+
+## Who is tigrbl for?
+
+Application developers, platform teams, and service owners building schema-first Python APIs.
+
+## Where does tigrbl fit?
+
+`tigrbl` lives at `pkgs/core/tigrbl` and serves schema-first service authoring, REST and JSON-RPC projection, docs, engines, and CLI workflows.
+
+## How does tigrbl work?
+
+It re-exports stable author-facing classes and decorators while delegating resident behavior to core, base, runtime, kernel, atoms, ORM, and operation packages.
+
+## Certification Status
+
+- Package status: governed package in the `tigrbl/tigrbl` workspace.
+- Governance source: [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json).
+- 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.
+- Local certification guard: `pkgs/core/tigrbl_tests/tests/unit/test_package_badges_and_notices.py` verifies every package README keeps the Discord badge, Apache 2.0 badge, explicit Python-version badge, `LICENSE`, and `NOTICE`.
+- Scope note: this README documents the package boundary. Runtime feature support remains governed by `.ssot/` entities and the conformance docs linked below.
+
 ## Install
 
 ```bash
@@ -286,35 +320,82 @@ pip install tigrbl
 Optional extras declared in `pyproject.toml`:
 
 ```bash
-pip install "tigrbl[postgres, servers, templates, tests]"
+pip install "tigrbl[postgres,servers,templates,tests]"
 ```
 
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | [`tigrbl`](https://pypi.org/project/tigrbl/) |
+| Repository path | [`pkgs/core/tigrbl`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl) |
+| Python import root | `tigrbl` |
+| Console scripts | `tigrbl` |
+| Entry points | none declared |
+| Optional extras | `postgres`, `servers`, `templates`, `tests` |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
 ## What It Owns
 
-`tigrbl` owns the public facade boundary for the Python workspace, re-exporting the author-facing app, router, ORM, decorator, security, and CLI surfaces while delegating resident behavior to split packages. Key implementation roots include `examples` with `swarmauri_tigrbl_bridge, swarmauri_tigrbl_bridge_smooth`; `tigrbl` with `__main__, canonical_json, cli, config/, ddl/, decorators/`.
+`tigrbl` owns the `public facade package` boundary. It should be installed when you need this package's focused responsibility without assuming every other Tigrbl workspace package is present.
 
-## Use It When
+Implementation orientation:
+- `tigrbl`: __main__, canonical_json, cli, config/, ddl/, decorators/, engine/, factories/, hook/, middlewares/, op/, orm/
 
-Use `tigrbl` when you want the public Python authoring surface in one install target: app composition, schema-first routing, REST and JSON-RPC projection, docs generation, and CLI workflow.
+## Public API and Import Surface
 
-## Public Surface
+- Import roots: `tigrbl`.
+- Public symbols: `APIKey`, `Alias`, `App`, `AppBase`, `AppSpec`, `Arity`, `BINDING_PROFILE_EXCHANGE_SUPPORT`, `BackgroundTask`, `Binding`, `BindingRegistry`, `BindingRegistrySpec`, `BindingSpec`.
+- Workspace dependencies: [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-base`](https://pypi.org/project/tigrbl-base/), [`tigrbl-concrete`](https://pypi.org/project/tigrbl-concrete/), [`tigrbl-canon`](https://pypi.org/project/tigrbl-canon/), [`tigrbl-orm`](https://pypi.org/project/tigrbl-orm/), [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/), [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/), [`tigrbl-kernel`](https://pypi.org/project/tigrbl-kernel/), [`tigrbl-ops-oltp`](https://pypi.org/project/tigrbl-ops-oltp/).
+- External runtime dependencies: `pydantic>=2.0.0`, `sqlalchemy>=2.0`, `aiosqlite>=0.19.0`, `httpx>=0.27.0`, `greenlet>=3.2.3`, `uvicorn`.
 
-- `tigrbl` exposes `import_module, extend_path, APIKey, Alias, App, BackgroundTask, Binding, BindingRegistry`.
-- Console scripts: `tigrbl`.
+## Usage Examples
 
-## Internal Layout
+### Verify the installed package
 
-- Workspace path: `pkgs/core/tigrbl`.
-- Package class: `facade package`.
-- Python requirement: `>=3.10,<3.15`.
-- `examples` modules: `swarmauri_tigrbl_bridge, swarmauri_tigrbl_bridge_smooth`.
-- `tigrbl` modules: `__main__, canonical_json, cli, config/, ddl/, decorators/, engine/, factories/, hook/, middlewares/`.
+```bash
+python -m pip show tigrbl
+python - <<'PY'
+from importlib.metadata import version
+print(version("tigrbl"))
+PY
+```
 
-## Dependency Surface
+### Create a small Tigrbl app shell
 
-- Workspace package dependencies: [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-base`](https://pypi.org/project/tigrbl-base/), [`tigrbl-concrete`](https://pypi.org/project/tigrbl-concrete/), [`tigrbl-canon`](https://pypi.org/project/tigrbl-canon/), [`tigrbl-orm`](https://pypi.org/project/tigrbl-orm/), [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/), [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/), [`tigrbl-kernel`](https://pypi.org/project/tigrbl-kernel/), [`tigrbl-ops-oltp`](https://pypi.org/project/tigrbl-ops-oltp/).
-- External runtime dependencies: `pydantic>=2.0.0`, `sqlalchemy>=2.0`, `aiosqlite>=0.19.0`, `httpx>=0.27.0`, `greenlet>=3.2.3`, `uvicorn`.
-- Optional extras: `rust`, `postgres`, `servers`, `templates`, `tests`.
+```python
+from tigrbl import TigrblApp, TigrblRouter
+
+app = TigrblApp()
+router = TigrblRouter()
+app.include_router(router)
+```
+
+### Use author-facing decorators
+
+```python
+from tigrbl import get, post
+
+@get("/health")
+def health() -> dict[str, str]:
+    return {"status": "ok"}
+
+@post("/items")
+def create_item(payload: dict) -> dict:
+    return payload
+```
+
+### Run the console entry point
+
+```bash
+tigrbl --help
+python -m tigrbl --help
+```
+
+## How To Choose This Package
+
+Choose `tigrbl` when you want the full public facade: app composition, schema-first routing, REST and JSON-RPC projection, docs generation, engine integration, and CLI workflow. 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/) only when you are building framework extensions or testing a specific internal boundary.
 
 ## Related Packages
 
@@ -326,23 +407,29 @@ Use `tigrbl` when you want the public Python authoring surface in one install ta
 - [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
 - [`tigrbl-atoms`](https://pypi.org/project/tigrbl-atoms/)
 - [`tigrbl-kernel`](https://pypi.org/project/tigrbl-kernel/)
+- [`tigrbl-ops-oltp`](https://pypi.org/project/tigrbl-ops-oltp/)
+
+## Documentation Links
+
+- [Workspace docs](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
+- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
+- [Package layout](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_LAYOUT.md)
+- [Current target](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_TARGET.md)
+- [Current state](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_STATE.md)
+- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
+- [Release workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml)
 
-## Canonical Repository Docs
+## Support
 
-- `docs/README.md`
-- `docs/conformance/CURRENT_TARGET.md`
-- `docs/conformance/CURRENT_STATE.md`
-- `docs/conformance/NEXT_STEPS.md`
-- `docs/governance/DOC_POINTERS.md`
-- `docs/developer/PACKAGE_CATALOG.md`
-- `docs/developer/PACKAGE_LAYOUT.md`
+- Community: [Discord](https://discord.gg/K4YTAPapjR).
+- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
+- Repository: [pkgs/core/tigrbl](https://github.com/tigrbl/tigrbl/tree/master/pkgs/core/tigrbl).
 
 ## Package-local Boundary
 
-This file is a package-local distribution entry point.
-Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
+This README is the package-local distribution entry point for `tigrbl`. It answers install, usage, API, ownership, and certification-orientation questions for this package. Broader architectural decisions, release status, and cross-package proof chains remain in the repository-level docs and SSOT registry.
 
 ## License
 
-Licensed under the Apache License, Version 2.0. See `LICENSE` and the official [Apache 2.0 license text](https://www.apache.org/licenses/LICENSE-2.0).
+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).
 

{tigrbl-0.4.2.dev3.dist-info → tigrbl-0.4.2.dev4.dist-info}/RECORD

@@ -104,8 +104,9 @@ tigrbl/vendor/__init__.py,sha256=RQZ9SR6hxUveFhVN2jyM2CaAV23fXa832sxB16CeWjQ,645
 tigrbl/vendor/jinja.py,sha256=sFr9Bq2luWDJPNMNFF7hCQcUyJOIzSwHwHrJ_k0yIh4,787
 tigrbl/vendor/pydantic.py,sha256=cLReo5Gd3V7TDJ9L3sMOFD93FWMd5QnZZoCaOJ6ip14,497
 tigrbl/vendor/sqlalchemy.py,sha256=mzc1kHispjk2n6Ll9xSPO7ZQ3Uq_BYECzS1o2Krifls,2456
-tigrbl-0.4.2.dev3.dist-info/METADATA,sha256=B1TnpIi-hmT6AOeIJ2vVA5P0JMZ9xEaYjC3zlZKT7qo,20475
-tigrbl-0.4.2.dev3.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
-tigrbl-0.4.2.dev3.dist-info/entry_points.txt,sha256=pXiN_KfMec0vJe-se_ATzXS7bEPFcQ-pGgmqS1_6j3E,50
-tigrbl-0.4.2.dev3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-tigrbl-0.4.2.dev3.dist-info/RECORD,,
+tigrbl-0.4.2.dev4.dist-info/METADATA,sha256=qe6HX5dvouGXKMVMPPlYBZicw9kGYqIYiecQUyz08RQ,24329
+tigrbl-0.4.2.dev4.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
+tigrbl-0.4.2.dev4.dist-info/entry_points.txt,sha256=pXiN_KfMec0vJe-se_ATzXS7bEPFcQ-pGgmqS1_6j3E,50
+tigrbl-0.4.2.dev4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tigrbl-0.4.2.dev4.dist-info/licenses/NOTICE,sha256=EvJMTshzsWz43LiK-DeN2ZuLtrP49cxvlrFlJ8F_buc,221
+tigrbl-0.4.2.dev4.dist-info/RECORD,,

tigrbl-0.4.2.dev4.dist-info/licenses/NOTICE

@@ -0,0 +1,7 @@
+Tigrbl
+Copyright 2026 Swarmauri
+
+This product includes software developed by Swarmauri.
+
+Tigrbl is licensed under the Apache License, Version 2.0.
+See the LICENSE file distributed with this work for the full license text.