pavedb-sdk 0.1.1__py3-none-any.whl

pavedb_sdk-0.1.1.dist-info/METADATA

@@ -0,0 +1,327 @@
+Metadata-Version: 2.4
+Name: pavedb-sdk
+Version: 0.1.1
+Summary: Python SDK for the PaveDB /v1 API
+Author-email: Flowlexi <pavedb@flowlexi.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://gitlab.com/flowlexi/pavedb-sdk-python
+Project-URL: Source, https://gitlab.com/flowlexi/pavedb-sdk-python
+Project-URL: Mirror, https://github.com/rodrigopitanga/pavedb-sdk-python
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Dynamic: license-file
+
+<!-- (C) 2026 Rodrigo Rodrigues da Silva <rodrigo@flowlexi.com> -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+# PaveDB Python SDK
+
+Python SDK package for the PaveDB `/v1` API.
+
+Use `pavedb-sdk` when your code should talk to PaveDB from Python.
+
+There are three runtime paths:
+
+- Connect to a PaveDB server over HTTP.
+- Install `pavedb` alongside the SDK and use the same `Client` /
+  `Collection` handle API with a local embedded engine.
+- Use ephemeral local mode for temporary in-process stores during tests,
+  notebooks, and short-lived experiments.
+
+To run your own server instance, use the PaveDB core repository:
+[GitLab](https://gitlab.com/flowlexi/pavedb) /
+[GitHub](https://github.com/rodrigopitanga/pavedb). The core repository
+remains the source of truth for the OpenAPI contract.
+
+SDK source lives on
+[GitLab](https://gitlab.com/flowlexi/pavedb-sdk-python) and
+[GitHub](https://github.com/rodrigopitanga/pavedb-sdk-python).
+
+## Install
+
+```bash
+pip install pavedb-sdk
+```
+
+SDK `0.1.x` targets the PaveDB `/v1` API. SDK package versions are
+independent from PaveDB core release versions; use `pavesdk.__version__`
+for the SDK release and `pavesdk.PAVEDB_API_PREFIX` for the wire API.
+
+For local embedded/persisted mode:
+
+```bash
+pip install pavedb-sdk pavedb
+```
+
+## Local Package Build
+
+Build the local PyPI package artifacts with GNU Make:
+
+```bash
+gmake package
+```
+
+That creates the source distribution (`.tar.gz`) and wheel in `dist/`,
+checks them with Twine, and copies them to `artifacts/`.
+
+Upload targets are explicit and do not infer release channels from the version:
+
+```bash
+gmake pypitest-push
+gmake pypi-push
+```
+
+Runnable HTTP examples are installed with the package:
+
+```bash
+python -m pavesdk.examples.http_search
+python -m pavesdk.examples.observability
+```
+
+The SDK checkout also includes `demo/20k_leagues.txt`, which the examples use
+via a hardcoded relative path.
+
+## HTTP Client
+
+```python
+from pavesdk.client import connect
+
+db = connect(
+    "http://localhost:8086",
+    api_key="super-sekret",
+    tenant="demo",
+)
+books = db.collection("books")
+
+hits = books.search("captain nemo", k=3)
+hits
+```
+
+```text
+[
+    {
+        "id": "note-1:0000",
+        "score": 0.86,
+        "text": "Captain Nemo commands the Nautilus.",
+        "meta": {"docid": "note-1", "kind": "note"},
+    },
+    {
+        "id": "note-2:0000",
+        "score": 0.73,
+        "text": "The Nautilus dives beneath the ice.",
+        "meta": {"docid": "note-2", "kind": "note"},
+    },
+]
+```
+
+```python
+for hit in hits:
+    print(hit["score"], hit["meta"]["docid"], hit["text"][:80])
+```
+
+```text
+0.86 note-1 Captain Nemo commands the Nautilus.
+0.73 note-2 The Nautilus dives beneath the ice.
+```
+
+`connect("http://...")` and `connect("https://...")` create an `HttpClient`.
+Bare paths are local targets and require `pavedb` to be installed.
+
+## Collections
+
+The API is handle-based: pick a collection once, then call methods on it.
+
+```python
+from pavesdk.client import connect
+
+db = connect("http://localhost:8086", api_key="super-sekret")
+books = db.create_collection("books", tenant="demo")
+
+books.add(
+    "Captain Nemo commands the Nautilus.",
+    docid="note-1",
+    metadata={"kind": "note"},
+)
+books.add_many([
+    ("The Nautilus dives beneath the ice.", "note-2", None),
+    {
+        "text": "Nemo studies ocean currents.",
+        "docid": "note-3",
+        "metadata": {"kind": "note"},
+    },
+])
+
+matches = books.search(
+    "submarine captain",
+    k=5,
+    filters={"kind": "note"},
+)
+matches
+```
+
+```text
+[
+    {
+        "id": "note-1:0000",
+        "score": 0.81,
+        "text": "Captain Nemo commands the Nautilus.",
+        "meta": {"docid": "note-1", "kind": "note"},
+    },
+    {
+        "id": "note-3:0000",
+        "score": 0.69,
+        "text": "Nemo studies ocean currents.",
+        "meta": {"docid": "note-3", "kind": "note"},
+    },
+]
+```
+
+## Observability
+
+Searches are logged by PaveDB. Use query inspection to see what ran, replay it
+against current data, and inspect the source chunks behind a document.
+
+```python
+from pavesdk.client import connect
+
+db = connect("http://localhost:8086", api_key="super-sekret")
+books = db.collection("books", tenant="demo")
+
+books.search("captain nemo", k=3)
+
+latest = books.queries(limit=1)[0]
+latest
+```
+
+```text
+{
+    "query_id": "0d4f5a1b-9e4b-41c7-8b3f-8f6b5de3e74a",
+    "tenant": "demo",
+    "collection": "books",
+    "query_text": "captain nemo",
+    "k": 3,
+    "filters": None,
+    "result_count": 2,
+    "latency_ms": 12.4,
+    "created_at": "2026-06-20T18:42:16.153201Z",
+}
+```
+
+```python
+query = books.get_query(latest["query_id"])
+query
+```
+
+```text
+{
+    "query_id": "0d4f5a1b-9e4b-41c7-8b3f-8f6b5de3e74a",
+    "tenant": "demo",
+    "collection": "books",
+    "query_text": "captain nemo",
+    "k": 3,
+    "filters": None,
+    "result_ids": ["note-1:0000", "note-2:0000"],
+    "result_count": 2,
+    "latency_ms": 12.4,
+}
+```
+
+```python
+replayed = books.replay(query["query_id"])
+replayed
+```
+
+```text
+[
+    {
+        "id": "note-1:0000",
+        "score": 0.86,
+        "text": "Captain Nemo commands the Nautilus.",
+        "meta": {"docid": "note-1", "kind": "note"},
+    },
+    {
+        "id": "note-2:0000",
+        "score": 0.73,
+        "text": "The Nautilus dives beneath the ice.",
+        "meta": {"docid": "note-2", "kind": "note"},
+    },
+]
+```
+
+```python
+docid = replayed[0]["meta"]["docid"]
+chunks = books.list_chunks(docid)
+chunks
+```
+
+```text
+[
+    {
+        "rid": "note-1:0000",
+        "docid": "note-1",
+        "chunk": 0,
+        "text": "Captain Nemo commands the Nautilus.",
+        "metadata": {"kind": "note"},
+    }
+]
+```
+
+```python
+chunk = books.get_chunk(chunks[0]["rid"])
+chunk
+```
+
+```text
+{
+    "rid": "note-1:0000",
+    "docid": "note-1",
+    "chunk": 0,
+    "text": "Captain Nemo commands the Nautilus.",
+    "metadata": {"kind": "note"},
+}
+```
+
+```python
+content = books.get_chunk_content(chunk["rid"])
+content
+```
+
+```text
+{
+    "content": b"Captain Nemo commands the Nautilus.",
+    "content_type": "text/plain; charset=utf-8",
+}
+```
+
+## Local Mode
+
+With `pavedb` installed, the same API can use a local persisted store:
+
+```python
+from pavesdk.client import connect
+
+with connect("./data", tenant="demo") as db:
+    books = db.create_collection("books")
+    books.add("Captain Nemo commands the Nautilus.", docid="note-1")
+    print(books.search("captain", k=3))
+```
+
+If `pavedb` is not installed, local targets raise `LocalClientUnavailable`.
+
+## Archives
+
+```python
+from pathlib import Path
+from pavesdk.client import connect
+
+with connect("http://localhost:8086", api_key="super-sekret") as db:
+    archive_bytes = db.dump_archive()
+    Path("pavedb-data.zip").write_bytes(archive_bytes)
+
+    saved_path = db.dump_archive("pavedb-data.zip")
+    db.restore_archive(Path(saved_path).read_bytes())
+```

pavedb_sdk-0.1.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+pavedb_sdk-0.1.1.dist-info/licenses/LICENSE,sha256=AWKw2jn2nZyYIm5-r3BeUYxO6dTn4-PFXulgptEoyqs,9240
+pavesdk/__init__.py,sha256=aWyHKEdRnZBvtTZHeYrTI4P7LqYVqiRAFgrvk4qQN0A,769
+pavesdk/batch.py,sha256=6sL3IiIunTba10wOKxlcr_udQJI4nSdQSH9DFXkLEec,1173
+pavesdk/client.py,sha256=aqzLxjpzdKes6v24ZNctQJpwooIRBaIJcRcYJWOBnfw,14211
+pavesdk/compat.py,sha256=H2WnNzC4ypL2DSLbnrcjCXf7RNmg36iw0MUWVfNvpp8,188
+pavesdk/errors.py,sha256=7BM32VU_CJ6NIeY5HW4Pqy31sL7gQNQ8_MAzhoom_zA,1660
+pavesdk/interface.py,sha256=Iq6beV8GkKcXf37abNt2mGIEN_CrvwtX_7V6BORIK30,9286
+pavesdk/providers.py,sha256=MBsuDEuNZHaE0Bql2G9foJSwH3pwAFbE8Im0ie3PwQ8,182
+pavesdk/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+pavesdk/examples/README.md,sha256=rSLqJxp-yBTdzqayPamH3ojFIE-B7m9_6mo2W7pV6Qg,713
+pavesdk/examples/__init__.py,sha256=yc_hRkEy1NDvGf8XDos_wBq4d7BWQ8r12w9DdiELDjw,161
+pavesdk/examples/__main__.py,sha256=Nte_uoCVbz2DRy57TEeMeCJRkVv2Ra_vxjKa2XsEF_4,341
+pavesdk/examples/http_search.py,sha256=MijNKA2uoY-eXOMdh88n8vXIewIeY9FIjT_W-HF54aU,1397
+pavesdk/examples/observability.py,sha256=7n8NRCW75sAaPqvIsfD8dW7JifvMxZp7bHLrpK3ApW8,2172
+pavedb_sdk-0.1.1.dist-info/METADATA,sha256=noD97uz2as9eMhyaEMwQA3UgqvrznNxlSeL6eyNRIAY,7415
+pavedb_sdk-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pavedb_sdk-0.1.1.dist-info/top_level.txt,sha256=228gWC7DZN0YyOxxIEwhv0phs7kGNW_WrYgLQKw_iHM,8
+pavedb_sdk-0.1.1.dist-info/RECORD,,

pavedb_sdk-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pavedb_sdk-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer, and
+charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

pavedb_sdk-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pavesdk

pavesdk/__init__.py

@@ -0,0 +1,36 @@
+# (C) 2026 Rodrigo Rodrigues da Silva <rodrigo@flowlexi.com>
+# SPDX-License-Identifier: Apache-2.0
+
+"""Python SDK package for PaveDB."""
+
+from .batch import batch_item
+from .client import HttpClient, connect
+from .compat import PAVEDB_API_PREFIX, PAVEDB_API_VERSION
+from .errors import (
+    Conflict,
+    InvalidRequest,
+    LocalClientUnavailable,
+    NotFoundError,
+    PaveError,
+    Unavailable,
+)
+from .interface import BaseClient, Collection
+
+__all__ = [
+    "BaseClient",
+    "Collection",
+    "Conflict",
+    "HttpClient",
+    "InvalidRequest",
+    "LocalClientUnavailable",
+    "NotFoundError",
+    "PaveError",
+    "PAVEDB_API_PREFIX",
+    "PAVEDB_API_VERSION",
+    "Unavailable",
+    "__version__",
+    "batch_item",
+    "connect",
+]
+
+__version__ = "0.1.1"

pavesdk/batch.py

@@ -0,0 +1,36 @@
+# (C) 2026 Rodrigo Rodrigues da Silva <rodrigo@flowlexi.com>
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any
+
+from .errors import InvalidRequest
+
+JsonMap = dict[str, Any]
+
+
+def batch_item(document: object) -> JsonMap:
+    if isinstance(document, str):
+        return {"text": document}
+    if isinstance(document, Mapping):
+        return {
+            "text": document.get("text"),
+            "docid": document.get("docid"),
+            "metadata": document.get("metadata"),
+        }
+    if isinstance(document, (tuple, list)):
+        if not 1 <= len(document) <= 3:
+            raise InvalidRequest(
+                "invalid_batch_item",
+                "batch items must be text, (text, docid, metadata), or a dict",
+            )
+        text = document[0]
+        docid = document[1] if len(document) > 1 else None
+        metadata = document[2] if len(document) > 2 else None
+        return {"text": text, "docid": docid, "metadata": metadata}
+    raise InvalidRequest(
+        "invalid_batch_item",
+        "batch items must be text, (text, docid, metadata), or a dict",
+    )