tigrbl_engine_clickhouse 0.4.2.dev3__tar.gz → 0.4.2.dev4__tar.gz

tigrbl_engine_clickhouse-0.4.2.dev4/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.

{tigrbl_engine_clickhouse-0.4.2.dev3/src/tigrbl_engine_clickhouse.egg-info → tigrbl_engine_clickhouse-0.4.2.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tigrbl_engine_clickhouse
-Version: 0.4.2.dev3
+Version: 0.4.2.dev4
 Summary: ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
 Author-email: Jacob Stewart <jacob@swarmauri.com>
 License:                                  Apache License
@@ -231,6 +231,7 @@ Classifier: Topic :: Database
 Requires-Python: <3.15,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+License-File: NOTICE
 Requires-Dist: tigrbl>=0.3.0.dev4
 Requires-Dist: clickhouse-connect>=0.6.0
 Dynamic: license-file
@@ -241,12 +242,45 @@ Dynamic: license-file
 <p><strong>ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.</strong></p>
 <a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_clickhouse?label=PyPI" alt="PyPI version for tigrbl_engine_clickhouse"/></a>
 <a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://static.pepy.tech/badge/tigrbl_engine_clickhouse" alt="Downloads for tigrbl_engine_clickhouse"/></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_engine_clickhouse"/></a>
 <a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_clickhouse 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_engine_clickhouse"/></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_engine_clickhouse"/></a>
 <a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-engines-1f6feb" alt="Workspace group for tigrbl_engine_clickhouse"/></a>
 </div>
 
+## What is tigrbl_engine_clickhouse?
+
+ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
+
+## Why use tigrbl_engine_clickhouse?
+
+Use it when a Tigrbl application needs this backend without installing every engine package.
+
+## When should I install tigrbl_engine_clickhouse?
+
+Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.
+
+## Who is tigrbl_engine_clickhouse for?
+
+Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.
+
+## Where does tigrbl_engine_clickhouse fit?
+
+`tigrbl_engine_clickhouse` lives at `pkgs/engines/tigrbl_engine_clickhouse` and serves ClickHouse analytical workloads.
+
+## How does tigrbl_engine_clickhouse work?
+
+It exposes a `tigrbl.engine` entry point and a package `register()` hook so Tigrbl can discover or load the backend at runtime.
+
+## 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
@@ -257,50 +291,105 @@ uv add tigrbl_engine_clickhouse
 pip install tigrbl_engine_clickhouse
 ```
 
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | [`tigrbl_engine_clickhouse`](https://pypi.org/project/tigrbl_engine_clickhouse/) |
+| Repository path | [`pkgs/engines/tigrbl_engine_clickhouse`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse) |
+| Python import root | `tigrbl_engine_clickhouse` |
+| Console scripts | none declared |
+| Entry points | `tigrbl.engine` |
+| Optional extras | none declared |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
 ## What It Owns
 
-`tigrbl_engine_clickhouse` owns the engine clickhouse backend boundary for Tigrbl, including engine registration, session adapters, and backend-specific helpers. Key implementation roots include `tigrbl_engine_clickhouse` with `engine, session`.
+`tigrbl_engine_clickhouse` owns the `engine plugin` 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_engine_clickhouse`: engine, session
 
-Use `tigrbl_engine_clickhouse` when you want the engine clickhouse backend installed as an isolated dependency instead of pulling every engine into your environment.
+## Public API and Import Surface
 
-## Public Surface
+- Import roots: `tigrbl_engine_clickhouse`.
+- Public symbols: `ClickHouseEngine`, `ClickHouseSession`, `clickhouse_engine`, `register`.
+- Workspace dependencies: [`tigrbl`](https://pypi.org/project/tigrbl/).
+- External runtime dependencies: `clickhouse-connect>=0.6.0`.
 
-- `tigrbl_engine_clickhouse` exposes `ClickHouseEngine, clickhouse_engine, ClickHouseSession, register`.
+## Usage Examples
 
-## Internal Layout
+### Verify the installed package
 
-- Workspace path: `pkgs/engines/tigrbl_engine_clickhouse`.
-- Package class: `engine plugin`.
-- Python requirement: `>=3.10,<3.15`.
-- `tigrbl_engine_clickhouse` modules: `engine, session`.
+```bash
+python -m pip show tigrbl_engine_clickhouse
+python - <<'PY'
+from importlib.metadata import version
+print(version("tigrbl_engine_clickhouse"))
+PY
+```
+
+### Register the engine plugin explicitly
+
+```python
+from tigrbl_engine_clickhouse import register
+
+register()
+```
+
+### Discover the engine through package metadata
+
+```python
+from importlib.metadata import entry_points
 
-## Dependency Surface
+for entry_point in entry_points(group="tigrbl.engine"):
+    if entry_point.module.startswith("tigrbl_engine_clickhouse"):
+        plugin_register = entry_point.load()
+        plugin_register()
+```
+
+### Install alongside the facade
+
+```bash
+uv add tigrbl tigrbl_engine_clickhouse
+pip install tigrbl tigrbl_engine_clickhouse
+```
+
+## How To Choose This Package
 
-- Workspace package dependencies: none declared.
-- External runtime dependencies: `tigrbl>=0.3.0.dev4`, `clickhouse-connect>=0.6.0`.
-- Optional extras: none declared.
+Choose `tigrbl_engine_clickhouse` 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.
 
 ## Related Packages
 
 - [`tigrbl`](https://pypi.org/project/tigrbl/)
+- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
+- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
+- [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/)
+- [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/)
+- [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/)
+- [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/)
+
+## 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/engines/tigrbl_engine_clickhouse](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse).
 
 ## 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_engine_clickhouse`. 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_engine_clickhouse-0.4.2.dev4/README.md

@@ -0,0 +1,157 @@
+<div align="center">
+<h1>tigrbl_engine_clickhouse</h1>
+<img src="https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png" alt="Tigrbl logo" width="140"/>
+<p><strong>ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.</strong></p>
+<a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_clickhouse?label=PyPI" alt="PyPI version for tigrbl_engine_clickhouse"/></a>
+<a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://static.pepy.tech/badge/tigrbl_engine_clickhouse" alt="Downloads for tigrbl_engine_clickhouse"/></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_engine_clickhouse"/></a>
+<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_clickhouse 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%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_engine_clickhouse"/></a>
+<a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-engines-1f6feb" alt="Workspace group for tigrbl_engine_clickhouse"/></a>
+</div>
+
+## What is tigrbl_engine_clickhouse?
+
+ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
+
+## Why use tigrbl_engine_clickhouse?
+
+Use it when a Tigrbl application needs this backend without installing every engine package.
+
+## When should I install tigrbl_engine_clickhouse?
+
+Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.
+
+## Who is tigrbl_engine_clickhouse for?
+
+Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.
+
+## Where does tigrbl_engine_clickhouse fit?
+
+`tigrbl_engine_clickhouse` lives at `pkgs/engines/tigrbl_engine_clickhouse` and serves ClickHouse analytical workloads.
+
+## How does tigrbl_engine_clickhouse work?
+
+It exposes a `tigrbl.engine` entry point and a package `register()` hook so Tigrbl can discover or load the backend at runtime.
+
+## 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
+uv add tigrbl_engine_clickhouse
+```
+
+```bash
+pip install tigrbl_engine_clickhouse
+```
+
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | [`tigrbl_engine_clickhouse`](https://pypi.org/project/tigrbl_engine_clickhouse/) |
+| Repository path | [`pkgs/engines/tigrbl_engine_clickhouse`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse) |
+| Python import root | `tigrbl_engine_clickhouse` |
+| Console scripts | none declared |
+| Entry points | `tigrbl.engine` |
+| Optional extras | none declared |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
+## What It Owns
+
+`tigrbl_engine_clickhouse` owns the `engine plugin` boundary. It should be installed when you need this package's focused responsibility without assuming every other Tigrbl workspace package is present.
+
+Implementation orientation:
+- `tigrbl_engine_clickhouse`: engine, session
+
+## Public API and Import Surface
+
+- Import roots: `tigrbl_engine_clickhouse`.
+- Public symbols: `ClickHouseEngine`, `ClickHouseSession`, `clickhouse_engine`, `register`.
+- Workspace dependencies: [`tigrbl`](https://pypi.org/project/tigrbl/).
+- External runtime dependencies: `clickhouse-connect>=0.6.0`.
+
+## Usage Examples
+
+### Verify the installed package
+
+```bash
+python -m pip show tigrbl_engine_clickhouse
+python - <<'PY'
+from importlib.metadata import version
+print(version("tigrbl_engine_clickhouse"))
+PY
+```
+
+### Register the engine plugin explicitly
+
+```python
+from tigrbl_engine_clickhouse import register
+
+register()
+```
+
+### Discover the engine through package metadata
+
+```python
+from importlib.metadata import entry_points
+
+for entry_point in entry_points(group="tigrbl.engine"):
+    if entry_point.module.startswith("tigrbl_engine_clickhouse"):
+        plugin_register = entry_point.load()
+        plugin_register()
+```
+
+### Install alongside the facade
+
+```bash
+uv add tigrbl tigrbl_engine_clickhouse
+pip install tigrbl tigrbl_engine_clickhouse
+```
+
+## How To Choose This Package
+
+Choose `tigrbl_engine_clickhouse` 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.
+
+## Related Packages
+
+- [`tigrbl`](https://pypi.org/project/tigrbl/)
+- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
+- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
+- [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/)
+- [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/)
+- [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/)
+- [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/)
+
+## 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)
+
+## Support
+
+- Community: [Discord](https://discord.gg/K4YTAPapjR).
+- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
+- Repository: [pkgs/engines/tigrbl_engine_clickhouse](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse).
+
+## Package-local Boundary
+
+This README is the package-local distribution entry point for `tigrbl_engine_clickhouse`. 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`, `NOTICE`, and the official [Apache 2.0 license text](https://www.apache.org/licenses/LICENSE-2.0).

{tigrbl_engine_clickhouse-0.4.2.dev3 → tigrbl_engine_clickhouse-0.4.2.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tigrbl_engine_clickhouse"
-version = "0.4.2.dev3"
+version = "0.4.2.dev4"
 description = "ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration."
 readme = "README.md"
 license = { file = "LICENSE" }

{tigrbl_engine_clickhouse-0.4.2.dev3 → tigrbl_engine_clickhouse-0.4.2.dev4/src/tigrbl_engine_clickhouse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tigrbl_engine_clickhouse
-Version: 0.4.2.dev3
+Version: 0.4.2.dev4
 Summary: ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
 Author-email: Jacob Stewart <jacob@swarmauri.com>
 License:                                  Apache License
@@ -231,6 +231,7 @@ Classifier: Topic :: Database
 Requires-Python: <3.15,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+License-File: NOTICE
 Requires-Dist: tigrbl>=0.3.0.dev4
 Requires-Dist: clickhouse-connect>=0.6.0
 Dynamic: license-file
@@ -241,12 +242,45 @@ Dynamic: license-file
 <p><strong>ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.</strong></p>
 <a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_clickhouse?label=PyPI" alt="PyPI version for tigrbl_engine_clickhouse"/></a>
 <a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://static.pepy.tech/badge/tigrbl_engine_clickhouse" alt="Downloads for tigrbl_engine_clickhouse"/></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_engine_clickhouse"/></a>
 <a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_clickhouse 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_engine_clickhouse"/></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_engine_clickhouse"/></a>
 <a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-engines-1f6feb" alt="Workspace group for tigrbl_engine_clickhouse"/></a>
 </div>
 
+## What is tigrbl_engine_clickhouse?
+
+ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.
+
+## Why use tigrbl_engine_clickhouse?
+
+Use it when a Tigrbl application needs this backend without installing every engine package.
+
+## When should I install tigrbl_engine_clickhouse?
+
+Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.
+
+## Who is tigrbl_engine_clickhouse for?
+
+Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.
+
+## Where does tigrbl_engine_clickhouse fit?
+
+`tigrbl_engine_clickhouse` lives at `pkgs/engines/tigrbl_engine_clickhouse` and serves ClickHouse analytical workloads.
+
+## How does tigrbl_engine_clickhouse work?
+
+It exposes a `tigrbl.engine` entry point and a package `register()` hook so Tigrbl can discover or load the backend at runtime.
+
+## 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
@@ -257,50 +291,105 @@ uv add tigrbl_engine_clickhouse
 pip install tigrbl_engine_clickhouse
 ```
 
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | [`tigrbl_engine_clickhouse`](https://pypi.org/project/tigrbl_engine_clickhouse/) |
+| Repository path | [`pkgs/engines/tigrbl_engine_clickhouse`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse) |
+| Python import root | `tigrbl_engine_clickhouse` |
+| Console scripts | none declared |
+| Entry points | `tigrbl.engine` |
+| Optional extras | none declared |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
 ## What It Owns
 
-`tigrbl_engine_clickhouse` owns the engine clickhouse backend boundary for Tigrbl, including engine registration, session adapters, and backend-specific helpers. Key implementation roots include `tigrbl_engine_clickhouse` with `engine, session`.
+`tigrbl_engine_clickhouse` owns the `engine plugin` 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_engine_clickhouse`: engine, session
 
-Use `tigrbl_engine_clickhouse` when you want the engine clickhouse backend installed as an isolated dependency instead of pulling every engine into your environment.
+## Public API and Import Surface
 
-## Public Surface
+- Import roots: `tigrbl_engine_clickhouse`.
+- Public symbols: `ClickHouseEngine`, `ClickHouseSession`, `clickhouse_engine`, `register`.
+- Workspace dependencies: [`tigrbl`](https://pypi.org/project/tigrbl/).
+- External runtime dependencies: `clickhouse-connect>=0.6.0`.
 
-- `tigrbl_engine_clickhouse` exposes `ClickHouseEngine, clickhouse_engine, ClickHouseSession, register`.
+## Usage Examples
 
-## Internal Layout
+### Verify the installed package
 
-- Workspace path: `pkgs/engines/tigrbl_engine_clickhouse`.
-- Package class: `engine plugin`.
-- Python requirement: `>=3.10,<3.15`.
-- `tigrbl_engine_clickhouse` modules: `engine, session`.
+```bash
+python -m pip show tigrbl_engine_clickhouse
+python - <<'PY'
+from importlib.metadata import version
+print(version("tigrbl_engine_clickhouse"))
+PY
+```
+
+### Register the engine plugin explicitly
+
+```python
+from tigrbl_engine_clickhouse import register
+
+register()
+```
+
+### Discover the engine through package metadata
+
+```python
+from importlib.metadata import entry_points
 
-## Dependency Surface
+for entry_point in entry_points(group="tigrbl.engine"):
+    if entry_point.module.startswith("tigrbl_engine_clickhouse"):
+        plugin_register = entry_point.load()
+        plugin_register()
+```
+
+### Install alongside the facade
+
+```bash
+uv add tigrbl tigrbl_engine_clickhouse
+pip install tigrbl tigrbl_engine_clickhouse
+```
+
+## How To Choose This Package
 
-- Workspace package dependencies: none declared.
-- External runtime dependencies: `tigrbl>=0.3.0.dev4`, `clickhouse-connect>=0.6.0`.
-- Optional extras: none declared.
+Choose `tigrbl_engine_clickhouse` 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.
 
 ## Related Packages
 
 - [`tigrbl`](https://pypi.org/project/tigrbl/)
+- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
+- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
+- [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/)
+- [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/)
+- [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/)
+- [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/)
+
+## 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/engines/tigrbl_engine_clickhouse](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_clickhouse).
 
 ## 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_engine_clickhouse`. 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_engine_clickhouse-0.4.2.dev3 → tigrbl_engine_clickhouse-0.4.2.dev4}/src/tigrbl_engine_clickhouse.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+NOTICE
 README.md
 pyproject.toml
 src/tigrbl_engine_clickhouse/__init__.py

tigrbl_engine_clickhouse-0.4.2.dev3/README.md

@@ -1,69 +0,0 @@
-<div align="center">
-<h1>tigrbl_engine_clickhouse</h1>
-<img src="https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/tigrbl_full_logo.png" alt="Tigrbl logo" width="140"/>
-<p><strong>ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.</strong></p>
-<a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_clickhouse?label=PyPI" alt="PyPI version for tigrbl_engine_clickhouse"/></a>
-<a href="https://pypi.org/project/tigrbl_engine_clickhouse/"><img src="https://static.pepy.tech/badge/tigrbl_engine_clickhouse" alt="Downloads for tigrbl_engine_clickhouse"/></a>
-<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_clickhouse/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_clickhouse 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_engine_clickhouse"/></a>
-<a href="https://github.com/tigrbl/tigrbl/blob/master/docs/README.md"><img src="https://img.shields.io/badge/workspace-engines-1f6feb" alt="Workspace group for tigrbl_engine_clickhouse"/></a>
-</div>
-
-## Install
-
-```bash
-uv add tigrbl_engine_clickhouse
-```
-
-```bash
-pip install tigrbl_engine_clickhouse
-```
-
-## What It Owns
-
-`tigrbl_engine_clickhouse` owns the engine clickhouse backend boundary for Tigrbl, including engine registration, session adapters, and backend-specific helpers. Key implementation roots include `tigrbl_engine_clickhouse` with `engine, session`.
-
-## Use It When
-
-Use `tigrbl_engine_clickhouse` when you want the engine clickhouse backend installed as an isolated dependency instead of pulling every engine into your environment.
-
-## Public Surface
-
-- `tigrbl_engine_clickhouse` exposes `ClickHouseEngine, clickhouse_engine, ClickHouseSession, register`.
-
-## Internal Layout
-
-- Workspace path: `pkgs/engines/tigrbl_engine_clickhouse`.
-- Package class: `engine plugin`.
-- Python requirement: `>=3.10,<3.15`.
-- `tigrbl_engine_clickhouse` modules: `engine, session`.
-
-## Dependency Surface
-
-- Workspace package dependencies: none declared.
-- External runtime dependencies: `tigrbl>=0.3.0.dev4`, `clickhouse-connect>=0.6.0`.
-- Optional extras: none declared.
-
-## Related Packages
-
-- [`tigrbl`](https://pypi.org/project/tigrbl/)
-
-## Canonical Repository Docs
-
-- `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`
-
-## 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/`.
-
-## 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).