tigrbl_engine_duckdb 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_engine_duckdb-0.4.2.dev4/NOTICE +7 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/PKG-INFO +115 -27
- tigrbl_engine_duckdb-0.4.2.dev4/README.md +156 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/pyproject.toml +1 -1
- tigrbl_engine_duckdb-0.4.2.dev3/README.md +0 -69
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/.gitignore +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/LICENSE +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/src/tigrbl_engine_duckdb/__init__.py +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/src/tigrbl_engine_duckdb/duck_builder.py +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/src/tigrbl_engine_duckdb/duck_session.py +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/src/tigrbl_engine_duckdb/plugin.py +0 -0
- {tigrbl_engine_duckdb-0.4.2.dev3 → tigrbl_engine_duckdb-0.4.2.dev4}/tests/test_smoke.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: tigrbl_engine_duckdb
|
|
3
|
-
Version: 0.4.2.
|
|
3
|
+
Version: 0.4.2.dev4
|
|
4
4
|
Summary: DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.
|
|
5
5
|
Project-URL: Organization, https://github.com/tigrbl
|
|
6
6
|
Project-URL: Discord, https://discord.gg/K4YTAPapjR
|
|
@@ -210,6 +210,7 @@ License: Apache License
|
|
|
210
210
|
See the License for the specific language governing permissions and
|
|
211
211
|
limitations under the License.
|
|
212
212
|
License-File: LICENSE
|
|
213
|
+
License-File: NOTICE
|
|
213
214
|
Keywords: analytics,api,asgi,database,duckdb,engine,json-rpc,olap,openapi,openrpc,plugin,pydantic,rest,schema-first,sqlalchemy,tigrbl
|
|
214
215
|
Classifier: Development Status :: 3 - Alpha
|
|
215
216
|
Classifier: Framework :: AsyncIO
|
|
@@ -239,12 +240,45 @@ Description-Content-Type: text/markdown
|
|
|
239
240
|
<p><strong>DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.</strong></p>
|
|
240
241
|
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_duckdb?label=PyPI" alt="PyPI version for tigrbl_engine_duckdb"/></a>
|
|
241
242
|
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://static.pepy.tech/badge/tigrbl_engine_duckdb" alt="Downloads for tigrbl_engine_duckdb"/></a>
|
|
243
|
+
<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_duckdb"/></a>
|
|
242
244
|
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_duckdb README"/></a>
|
|
243
245
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
|
|
244
|
-
<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%
|
|
246
|
+
<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_duckdb"/></a>
|
|
245
247
|
<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_duckdb"/></a>
|
|
246
248
|
</div>
|
|
247
249
|
|
|
250
|
+
## What is tigrbl_engine_duckdb?
|
|
251
|
+
|
|
252
|
+
DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.
|
|
253
|
+
|
|
254
|
+
## Why use tigrbl_engine_duckdb?
|
|
255
|
+
|
|
256
|
+
Use it when a Tigrbl application needs this backend without installing every engine package.
|
|
257
|
+
|
|
258
|
+
## When should I install tigrbl_engine_duckdb?
|
|
259
|
+
|
|
260
|
+
Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.
|
|
261
|
+
|
|
262
|
+
## Who is tigrbl_engine_duckdb for?
|
|
263
|
+
|
|
264
|
+
Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.
|
|
265
|
+
|
|
266
|
+
## Where does tigrbl_engine_duckdb fit?
|
|
267
|
+
|
|
268
|
+
`tigrbl_engine_duckdb` lives at `pkgs/engines/tigrbl_engine_duckdb` and serves embedded analytical SQL and local OLAP workflows.
|
|
269
|
+
|
|
270
|
+
## How does tigrbl_engine_duckdb work?
|
|
271
|
+
|
|
272
|
+
It exposes a `tigrbl.engine` entry point and a package `register()` hook so Tigrbl can discover or load the backend at runtime.
|
|
273
|
+
|
|
274
|
+
## Certification Status
|
|
275
|
+
|
|
276
|
+
- Package status: governed package in the `tigrbl/tigrbl` workspace.
|
|
277
|
+
- Governance source: [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json).
|
|
278
|
+
- 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.
|
|
279
|
+
- 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`.
|
|
280
|
+
- Scope note: this README documents the package boundary. Runtime feature support remains governed by `.ssot/` entities and the conformance docs linked below.
|
|
281
|
+
|
|
248
282
|
## Install
|
|
249
283
|
|
|
250
284
|
```bash
|
|
@@ -255,50 +289,104 @@ uv add tigrbl_engine_duckdb
|
|
|
255
289
|
pip install tigrbl_engine_duckdb
|
|
256
290
|
```
|
|
257
291
|
|
|
292
|
+
## Surface Coverage
|
|
293
|
+
|
|
294
|
+
| Surface | Value |
|
|
295
|
+
|---|---|
|
|
296
|
+
| PyPI package | [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/) |
|
|
297
|
+
| Repository path | [`pkgs/engines/tigrbl_engine_duckdb`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_duckdb) |
|
|
298
|
+
| Python import root | `tigrbl_engine_duckdb` |
|
|
299
|
+
| Console scripts | none declared |
|
|
300
|
+
| Entry points | `tigrbl.engine` |
|
|
301
|
+
| Optional extras | none declared |
|
|
302
|
+
| Legal files | `LICENSE`, `NOTICE` |
|
|
303
|
+
| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
|
|
304
|
+
|
|
258
305
|
## What It Owns
|
|
259
306
|
|
|
260
|
-
`tigrbl_engine_duckdb` owns the engine
|
|
307
|
+
`tigrbl_engine_duckdb` 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.
|
|
261
308
|
|
|
262
|
-
|
|
309
|
+
Implementation orientation:
|
|
310
|
+
- `tigrbl_engine_duckdb`: duck_builder, duck_session, plugin
|
|
263
311
|
|
|
264
|
-
|
|
312
|
+
## Public API and Import Surface
|
|
265
313
|
|
|
266
|
-
|
|
314
|
+
- Import roots: `tigrbl_engine_duckdb`.
|
|
315
|
+
- Public symbols: `DuckDBSession`, `duckdb_capabilities`, `duckdb_engine`, `register`.
|
|
316
|
+
- Workspace dependencies: [`tigrbl`](https://pypi.org/project/tigrbl/).
|
|
317
|
+
- External runtime dependencies: `duckdb>=1.0.0`.
|
|
267
318
|
|
|
268
|
-
|
|
319
|
+
## Usage Examples
|
|
269
320
|
|
|
270
|
-
|
|
321
|
+
### Verify the installed package
|
|
271
322
|
|
|
272
|
-
|
|
273
|
-
-
|
|
274
|
-
-
|
|
275
|
-
|
|
323
|
+
```bash
|
|
324
|
+
python -m pip show tigrbl_engine_duckdb
|
|
325
|
+
python - <<'PY'
|
|
326
|
+
from importlib.metadata import version
|
|
327
|
+
print(version("tigrbl_engine_duckdb"))
|
|
328
|
+
PY
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### Register the engine plugin explicitly
|
|
332
|
+
|
|
333
|
+
```python
|
|
334
|
+
from tigrbl_engine_duckdb import register
|
|
335
|
+
|
|
336
|
+
register()
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Discover the engine through package metadata
|
|
340
|
+
|
|
341
|
+
```python
|
|
342
|
+
from importlib.metadata import entry_points
|
|
276
343
|
|
|
277
|
-
|
|
344
|
+
for entry_point in entry_points(group="tigrbl.engine"):
|
|
345
|
+
if entry_point.module.startswith("tigrbl_engine_duckdb"):
|
|
346
|
+
plugin_register = entry_point.load()
|
|
347
|
+
plugin_register()
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Install alongside the facade
|
|
351
|
+
|
|
352
|
+
```bash
|
|
353
|
+
uv add tigrbl tigrbl_engine_duckdb
|
|
354
|
+
pip install tigrbl tigrbl_engine_duckdb
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
## How To Choose This Package
|
|
278
358
|
|
|
279
|
-
-
|
|
280
|
-
- External runtime dependencies: `duckdb>=1.0.0`, `tigrbl>=0.3.0.dev4`.
|
|
281
|
-
- Optional extras: none declared.
|
|
359
|
+
Choose `tigrbl_engine_duckdb` 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.
|
|
282
360
|
|
|
283
361
|
## Related Packages
|
|
284
362
|
|
|
285
363
|
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
364
|
+
- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
|
|
365
|
+
- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
|
|
366
|
+
- [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/)
|
|
367
|
+
- [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/)
|
|
368
|
+
- [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/)
|
|
369
|
+
|
|
370
|
+
## Documentation Links
|
|
371
|
+
|
|
372
|
+
- [Workspace docs](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
|
|
373
|
+
- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
|
|
374
|
+
- [Package layout](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_LAYOUT.md)
|
|
375
|
+
- [Current target](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_TARGET.md)
|
|
376
|
+
- [Current state](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_STATE.md)
|
|
377
|
+
- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
|
|
378
|
+
- [Release workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml)
|
|
286
379
|
|
|
287
|
-
##
|
|
380
|
+
## Support
|
|
288
381
|
|
|
289
|
-
-
|
|
290
|
-
-
|
|
291
|
-
-
|
|
292
|
-
- `docs/conformance/NEXT_STEPS.md`
|
|
293
|
-
- `docs/governance/DOC_POINTERS.md`
|
|
294
|
-
- `docs/developer/PACKAGE_CATALOG.md`
|
|
295
|
-
- `docs/developer/PACKAGE_LAYOUT.md`
|
|
382
|
+
- Community: [Discord](https://discord.gg/K4YTAPapjR).
|
|
383
|
+
- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
|
|
384
|
+
- Repository: [pkgs/engines/tigrbl_engine_duckdb](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_duckdb).
|
|
296
385
|
|
|
297
386
|
## Package-local Boundary
|
|
298
387
|
|
|
299
|
-
This
|
|
300
|
-
Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
|
|
388
|
+
This README is the package-local distribution entry point for `tigrbl_engine_duckdb`. 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.
|
|
301
389
|
|
|
302
390
|
## License
|
|
303
391
|
|
|
304
|
-
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).
|
|
392
|
+
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).
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1>tigrbl_engine_duckdb</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>DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.</strong></p>
|
|
5
|
+
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_duckdb?label=PyPI" alt="PyPI version for tigrbl_engine_duckdb"/></a>
|
|
6
|
+
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://static.pepy.tech/badge/tigrbl_engine_duckdb" alt="Downloads for tigrbl_engine_duckdb"/></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_engine_duckdb"/></a>
|
|
8
|
+
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_duckdb 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_engine_duckdb"/></a>
|
|
11
|
+
<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_duckdb"/></a>
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
## What is tigrbl_engine_duckdb?
|
|
15
|
+
|
|
16
|
+
DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.
|
|
17
|
+
|
|
18
|
+
## Why use tigrbl_engine_duckdb?
|
|
19
|
+
|
|
20
|
+
Use it when a Tigrbl application needs this backend without installing every engine package.
|
|
21
|
+
|
|
22
|
+
## When should I install tigrbl_engine_duckdb?
|
|
23
|
+
|
|
24
|
+
Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.
|
|
25
|
+
|
|
26
|
+
## Who is tigrbl_engine_duckdb for?
|
|
27
|
+
|
|
28
|
+
Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.
|
|
29
|
+
|
|
30
|
+
## Where does tigrbl_engine_duckdb fit?
|
|
31
|
+
|
|
32
|
+
`tigrbl_engine_duckdb` lives at `pkgs/engines/tigrbl_engine_duckdb` and serves embedded analytical SQL and local OLAP workflows.
|
|
33
|
+
|
|
34
|
+
## How does tigrbl_engine_duckdb work?
|
|
35
|
+
|
|
36
|
+
It exposes a `tigrbl.engine` entry point and a package `register()` hook so Tigrbl can discover or load the backend at runtime.
|
|
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_engine_duckdb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pip install tigrbl_engine_duckdb
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Surface Coverage
|
|
57
|
+
|
|
58
|
+
| Surface | Value |
|
|
59
|
+
|---|---|
|
|
60
|
+
| PyPI package | [`tigrbl_engine_duckdb`](https://pypi.org/project/tigrbl_engine_duckdb/) |
|
|
61
|
+
| Repository path | [`pkgs/engines/tigrbl_engine_duckdb`](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_duckdb) |
|
|
62
|
+
| Python import root | `tigrbl_engine_duckdb` |
|
|
63
|
+
| Console scripts | none declared |
|
|
64
|
+
| Entry points | `tigrbl.engine` |
|
|
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_engine_duckdb` 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.
|
|
72
|
+
|
|
73
|
+
Implementation orientation:
|
|
74
|
+
- `tigrbl_engine_duckdb`: duck_builder, duck_session, plugin
|
|
75
|
+
|
|
76
|
+
## Public API and Import Surface
|
|
77
|
+
|
|
78
|
+
- Import roots: `tigrbl_engine_duckdb`.
|
|
79
|
+
- Public symbols: `DuckDBSession`, `duckdb_capabilities`, `duckdb_engine`, `register`.
|
|
80
|
+
- Workspace dependencies: [`tigrbl`](https://pypi.org/project/tigrbl/).
|
|
81
|
+
- External runtime dependencies: `duckdb>=1.0.0`.
|
|
82
|
+
|
|
83
|
+
## Usage Examples
|
|
84
|
+
|
|
85
|
+
### Verify the installed package
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
python -m pip show tigrbl_engine_duckdb
|
|
89
|
+
python - <<'PY'
|
|
90
|
+
from importlib.metadata import version
|
|
91
|
+
print(version("tigrbl_engine_duckdb"))
|
|
92
|
+
PY
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Register the engine plugin explicitly
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
from tigrbl_engine_duckdb import register
|
|
99
|
+
|
|
100
|
+
register()
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Discover the engine through package metadata
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
from importlib.metadata import entry_points
|
|
107
|
+
|
|
108
|
+
for entry_point in entry_points(group="tigrbl.engine"):
|
|
109
|
+
if entry_point.module.startswith("tigrbl_engine_duckdb"):
|
|
110
|
+
plugin_register = entry_point.load()
|
|
111
|
+
plugin_register()
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Install alongside the facade
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
uv add tigrbl tigrbl_engine_duckdb
|
|
118
|
+
pip install tigrbl tigrbl_engine_duckdb
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## How To Choose This Package
|
|
122
|
+
|
|
123
|
+
Choose `tigrbl_engine_duckdb` 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.
|
|
124
|
+
|
|
125
|
+
## Related Packages
|
|
126
|
+
|
|
127
|
+
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
128
|
+
- [`tigrbl-core`](https://pypi.org/project/tigrbl-core/)
|
|
129
|
+
- [`tigrbl-runtime`](https://pypi.org/project/tigrbl-runtime/)
|
|
130
|
+
- [`tigrbl_engine_sqlite`](https://pypi.org/project/tigrbl_engine_sqlite/)
|
|
131
|
+
- [`tigrbl_engine_postgres`](https://pypi.org/project/tigrbl_engine_postgres/)
|
|
132
|
+
- [`tigrbl_engine_pandas`](https://pypi.org/project/tigrbl_engine_pandas/)
|
|
133
|
+
|
|
134
|
+
## Documentation Links
|
|
135
|
+
|
|
136
|
+
- [Workspace docs](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
|
|
137
|
+
- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
|
|
138
|
+
- [Package layout](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_LAYOUT.md)
|
|
139
|
+
- [Current target](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_TARGET.md)
|
|
140
|
+
- [Current state](https://github.com/tigrbl/tigrbl/blob/master/docs/conformance/CURRENT_STATE.md)
|
|
141
|
+
- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
|
|
142
|
+
- [Release workflow](https://github.com/tigrbl/tigrbl/actions/workflows/publish.yml)
|
|
143
|
+
|
|
144
|
+
## Support
|
|
145
|
+
|
|
146
|
+
- Community: [Discord](https://discord.gg/K4YTAPapjR).
|
|
147
|
+
- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues).
|
|
148
|
+
- Repository: [pkgs/engines/tigrbl_engine_duckdb](https://github.com/tigrbl/tigrbl/tree/master/pkgs/engines/tigrbl_engine_duckdb).
|
|
149
|
+
|
|
150
|
+
## Package-local Boundary
|
|
151
|
+
|
|
152
|
+
This README is the package-local distribution entry point for `tigrbl_engine_duckdb`. 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.
|
|
153
|
+
|
|
154
|
+
## License
|
|
155
|
+
|
|
156
|
+
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).
|
|
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "tigrbl_engine_duckdb"
|
|
7
|
-
version = "0.4.2.
|
|
7
|
+
version = "0.4.2.dev4"
|
|
8
8
|
description = "DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration."
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
license = { file = "LICENSE" }
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
<h1>tigrbl_engine_duckdb</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>DuckDB engine plugin for embedded analytical database sessions, OLAP workloads, and Tigrbl engine registration.</strong></p>
|
|
5
|
-
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://img.shields.io/pypi/v/tigrbl_engine_duckdb?label=PyPI" alt="PyPI version for tigrbl_engine_duckdb"/></a>
|
|
6
|
-
<a href="https://pypi.org/project/tigrbl_engine_duckdb/"><img src="https://static.pepy.tech/badge/tigrbl_engine_duckdb" alt="Downloads for tigrbl_engine_duckdb"/></a>
|
|
7
|
-
<a href="https://github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md"><img src="https://hits.sh/github.com/tigrbl/tigrbl/blob/master/pkgs/engines/tigrbl_engine_duckdb/README.md.svg?label=hits" alt="Repository hits for tigrbl_engine_duckdb 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_engine_duckdb"/></a>
|
|
10
|
-
<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_duckdb"/></a>
|
|
11
|
-
</div>
|
|
12
|
-
|
|
13
|
-
## Install
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
uv add tigrbl_engine_duckdb
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
pip install tigrbl_engine_duckdb
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## What It Owns
|
|
24
|
-
|
|
25
|
-
`tigrbl_engine_duckdb` owns the engine duckdb backend boundary for Tigrbl, including engine registration, session adapters, and backend-specific helpers. Key implementation roots include `tigrbl_engine_duckdb` with `duck_builder, duck_session, plugin`.
|
|
26
|
-
|
|
27
|
-
## Use It When
|
|
28
|
-
|
|
29
|
-
Use `tigrbl_engine_duckdb` when you want the engine duckdb backend installed as an isolated dependency instead of pulling every engine into your environment.
|
|
30
|
-
|
|
31
|
-
## Public Surface
|
|
32
|
-
|
|
33
|
-
- `tigrbl_engine_duckdb` exposes `duckdb_engine, duckdb_capabilities, DuckDBSession, register`.
|
|
34
|
-
|
|
35
|
-
## Internal Layout
|
|
36
|
-
|
|
37
|
-
- Workspace path: `pkgs/engines/tigrbl_engine_duckdb`.
|
|
38
|
-
- Package class: `engine plugin`.
|
|
39
|
-
- Python requirement: `>=3.10,<3.15`.
|
|
40
|
-
- `tigrbl_engine_duckdb` modules: `duck_builder, duck_session, plugin`.
|
|
41
|
-
|
|
42
|
-
## Dependency Surface
|
|
43
|
-
|
|
44
|
-
- Workspace package dependencies: none declared.
|
|
45
|
-
- External runtime dependencies: `duckdb>=1.0.0`, `tigrbl>=0.3.0.dev4`.
|
|
46
|
-
- Optional extras: none declared.
|
|
47
|
-
|
|
48
|
-
## Related Packages
|
|
49
|
-
|
|
50
|
-
- [`tigrbl`](https://pypi.org/project/tigrbl/)
|
|
51
|
-
|
|
52
|
-
## Canonical Repository Docs
|
|
53
|
-
|
|
54
|
-
- `docs/README.md`
|
|
55
|
-
- `docs/conformance/CURRENT_TARGET.md`
|
|
56
|
-
- `docs/conformance/CURRENT_STATE.md`
|
|
57
|
-
- `docs/conformance/NEXT_STEPS.md`
|
|
58
|
-
- `docs/governance/DOC_POINTERS.md`
|
|
59
|
-
- `docs/developer/PACKAGE_CATALOG.md`
|
|
60
|
-
- `docs/developer/PACKAGE_LAYOUT.md`
|
|
61
|
-
|
|
62
|
-
## Package-local Boundary
|
|
63
|
-
|
|
64
|
-
This file is a package-local distribution entry point.
|
|
65
|
-
Use this page for package installation and boundary orientation. Repository governance, conformance state, target status, and release evidence remain governed from `docs/` and `.ssot/`.
|
|
66
|
-
|
|
67
|
-
## License
|
|
68
|
-
|
|
69
|
-
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
|