dirsql 0.3.82__cp311-abi3-win_amd64.whl

dirsql-0.3.82.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: dirsql
+Version: 0.3.82
+Summary: Ephemeral SQL index over a local directory
+Keywords: sql,filesystem,directory,sqlite,index
+Author: Kevin Scott
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# `dirsql` (Python SDK)
+
+Ephemeral SQL index over a local directory. `dirsql` watches a filesystem, ingests structured files into an in-memory SQLite database, and exposes a SQL query interface -- the filesystem is always the source of truth.
+
+[Documentation](https://thekevinscott.github.io/dirsql/?lang=python)
+
+Also available as [`dirsql` on crates.io](https://crates.io/crates/dirsql) and [`dirsql` on npm](https://www.npmjs.com/package/dirsql).
+
+## Installation
+
+```bash
+pip install dirsql
+```
+
+Requires Python >= 3.12. Ships as a native extension (Rust via PyO3); prebuilt binary wheels are provided for common platforms.
+
+## Quick start
+
+`DirSQL` is async by default: the constructor returns immediately, scanning runs in a background thread, and you `await db.ready()` before querying. Each table is a `(ddl, glob, extract)` triple: the DDL defines the SQLite schema, the glob selects files (relative to the root), and `extract` turns a matched file into a list of row dicts. `dirsql` does not read file contents -- if `extract` needs the file body it reads `path` itself; return an empty list to skip a file.
+
+```python
+import asyncio
+import json
+from dirsql import DirSQL, Table
+
+async def main():
+    db = DirSQL(
+        "./my-blog",
+        tables=[
+            Table(
+                ddl="CREATE TABLE posts (title TEXT, author TEXT)",
+                glob="posts/*.json",
+                extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
+            ),
+        ],
+    )
+    await db.ready()
+
+    posts = await db.query("SELECT * FROM posts WHERE author = 'alice'")
+    print(posts)
+
+asyncio.run(main())
+```
+
+## Multiple tables and joins
+
+```python
+db = DirSQL(
+    "./my-blog",
+    tables=[
+        Table(
+            ddl="CREATE TABLE posts (title TEXT, author_id TEXT)",
+            glob="posts/*.json",
+            extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
+        ),
+        Table(
+            ddl="CREATE TABLE authors (id TEXT, name TEXT)",
+            glob="authors/*.json",
+            extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
+        ),
+    ],
+)
+await db.ready()
+
+results = await db.query("""
+    SELECT posts.title, authors.name
+    FROM posts JOIN authors ON posts.author_id = authors.id
+""")
+```
+
+## Ignoring files
+
+Pass `ignore` patterns to skip files during scanning and watching:
+
+```python
+db = DirSQL(
+    "./my-blog",
+    ignore=["**/drafts/**", "**/.git/**"],
+    tables=[...],
+)
+```
+
+## Loading SQLite extensions
+
+Pass `extensions` to load SQLite extension shared libraries onto the connection at startup (before any `CREATE TABLE`). Each entry is a dict with a `path` and an optional `entrypoint` init-symbol override:
+
+```python
+db = DirSQL(
+    "./my-blog",
+    tables=[...],
+    extensions=[
+        {"path": "./ext/vec0.dylib", "entrypoint": "sqlite3_vec_init"},
+        {"path": "./ext/myext.so"},  # entrypoint derived from the filename
+    ],
+)
+await db.ready()
+
+# The extension's functions are now callable in queries:
+rows = await db.query("SELECT vec_version() AS v")
+```
+
+`dirsql` enables extension loading only while loading the configured libraries, then disables it again, so the SQL `load_extension()` function is never exposed to your queries. Programmatic entries load first, followed by any `[[dirsql.extension]]` entries declared in a `config` file. See the [config reference](https://github.com/thekevinscott/dirsql/blob/main/docs/reference/config.md#dirsqlextension).
+
+## Watching for changes
+
+`db.watch()` returns an async iterator of row-level change events as files change on disk:
+
+```python
+async for event in db.watch():
+    print(f"{event.action} on {event.table}: {event.row}")
+    if event.action == "error":
+        print(f"  error: {event.error}")
+```
+
+Each event has `.action` (`"insert"`, `"update"`, `"delete"`, or `"error"`), `.table`, `.row` (the new row, or the deleted row on `delete`), `.old_row` (the previous row, on `update`), `.file_path`, and `.error` (on `error`).
+
+## CLI
+
+`pip install dirsql` also installs a `dirsql` console script that runs an HTTP server exposing the SDK over HTTP: `POST /query` for SQL and `GET /events` for a Server-Sent Events change stream. Run `dirsql` (or `uvx dirsql`) to start it. See the [CLI reference](https://thekevinscott.github.io/dirsql/reference/cli).
+
+## License
+
+MIT
+

dirsql-0.3.82.dist-info/RECORD

@@ -0,0 +1,18 @@
+dirsql/__init__.py,sha256=R4O-oQ4SvQQJqoBEeovbAGMu82hBii_FVlCvLTxXQHc,300
+dirsql/_async.py,sha256=upENiNP85rHIijjtrLg5EazKbs1hTYO-mbfNEIisWOU,6674
+dirsql/_binary/dirsql.exe,sha256=FW4s46VeeTExjnWbB7fxqu7sq3TVrNll2Rem227fHqA,6820864
+dirsql/_dirsql.pyd,sha256=03Sm1-JhYjG7syRMm_nXanY1z6JgR-cbF87PLrpYzr4,4998656
+dirsql/_dirsql.pyi,sha256=IktVp22ELjIwFLtiCmQyhSAYLhxzQQJPCoe2-FLCtFA,2198
+dirsql/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dirsql/cli/binary_path.py,sha256=Sd_dYCmifwlWqSgziVlMYd905b6PyydANewgkmvom7g,729
+dirsql/cli/is_windows.py,sha256=SixXdOcdeRmvuSClwRtctyv2wF-xoCnLLscmZZygZEs,154
+dirsql/cli/main.py,sha256=TxbEJNl5qfO8gNJCvjFH-BZ7RBNdZZSzu4RXi1fgKbw,1113
+dirsql/cli/resolve_config_extensions.py,sha256=MyjTWGBtPqn8MFZWe5pUWLMvrEfcORDohfWRPF-thNM,2363
+dirsql/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dirsql/resolve_config_extensions.py,sha256=VK6Qjnh-_jqAmH-5FzJQ7FQ6HaNU0zXQVZSarWAeA3M,2558
+dirsql/resolve_extension.py,sha256=uj2nZfhOW5CKH_PhgCqDmEBSPGhXPYjkpi8wiy9Wbyc,3809
+dirsql-0.3.82.dist-info/METADATA,sha256=nhD_2SzITfY2ipnSM6xnSqoOfl0JiXTchOuwIxy0pl0,4785
+dirsql-0.3.82.dist-info/WHEEL,sha256=nv5WBZ27cxxDjIIqxBMqK2cOF025DwkFmqJGqL3SpXU,96
+dirsql-0.3.82.dist-info/entry_points.txt,sha256=tudtE91DSGc4rRXqbZurACS8VizzUBfhdQL63Ta0LbI,46
+dirsql-0.3.82.dist-info/sboms/dirsql-py-ext.cyclonedx.json,sha256=vNjaII3tK4WzwHKTfv68NtR5IV2X0JvDdzy8pY4gH14,93903
+dirsql-0.3.82.dist-info/RECORD,,

dirsql-0.3.82.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: cp311-abi3-win_amd64

dirsql-0.3.82.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dirsql=dirsql.cli.main:main