beaver-db 0.17.6__py3-none-any.whl → 0.18.1__py3-none-any.whl

beaver/__init__.py

@@ -1,3 +1,5 @@
 from .core import BeaverDB
 from .types import Model
 from .collections import Document, WalkDirection
+
+__version__ = "0.17.6"

beaver/cli.py

@@ -1,10 +1,35 @@
 import typer
 import rich
 from typing_extensions import Annotated
+import beaver
 
 app = typer.Typer()
 
 
+def version_callback(value: bool):
+    if value:
+        print(beaver.__version__)
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: Annotated[
+        bool,
+        typer.Option(
+            "--version",
+            callback=version_callback,
+            is_eager=True,
+            help="Show the version and exit.",
+        ),
+    ] = False,
+):
+    """
+    BeaverDB command-line interface.
+    """
+    pass
+
+
 @app.command()
 def serve(
     database: Annotated[

beaver/collections.py

@@ -96,13 +96,20 @@ class Document(Model):
     def to_dict(self) -> dict[str, Any]:
         """Serializes the document's metadata to a dictionary."""
         metadata = self.__dict__.copy()
-        metadata.pop("embedding", None)
-        metadata.pop("id", None)
+        metadata["embedding"] = self.embedding.tolist() if self.embedding is not None else None
         return metadata
 
     def __repr__(self):
+        d = self.to_dict()
+        d.pop("embedding")
         metadata_str = ", ".join(f"{k}={v!r}" for k, v in self.to_dict().items())
-        return f"Document(id='{self.id}', {metadata_str})"
+        return f"Document({metadata_str})"
+
+    def model_dump_json(self) -> str:
+        d = self.to_dict()
+        d.pop("embedding")
+        d.pop("id")
+        return json.dumps(d)
 
 
 class CollectionManager[D: Document]:
@@ -323,7 +330,7 @@ class CollectionManager[D: Document]:
             if doc_id in doc_map:
                 doc = doc_map[doc_id]
                 distance = distance_map[doc_id]
-                final_results.append((doc, distance))
+                final_results.append((doc, float(distance)))
 
         return final_results
 

beaver/server.py

@@ -270,7 +270,7 @@ def build(db: BeaverDB) -> FastAPI:
     def get_all_documents(name: str) -> List[dict]:
         """Retrieves all documents in the collection."""
         collection = db.collection(name)
-        return [doc.model_dump() for doc in collection]
+        return [doc.to_dict() for doc in collection]
 
     @app.post("/collections/{name}/index", tags=["Collections"])
     def index_document(name: str, req: IndexRequest):
@@ -281,8 +281,8 @@ def build(db: BeaverDB) -> FastAPI:
             collection.index(doc, fts=req.fts, fuzzy=req.fuzzy)
             return {"status": "ok", "id": doc.id}
         except TypeError as e:
-            if "faiss" in str(e):
-                raise HTTPException(status_code=501, detail="Vector indexing requires the '[faiss]' extra. Install with: pip install \"beaver-db[faiss]\"")
+            if "vector" in str(e):
+                raise HTTPException(status_code=501, detail="Vector indexing requires the '[vector]' extra. Install with: pip install \"beaver-db[vector]\"")
             raise e
 
     @app.post("/collections/{name}/search", tags=["Collections"])
@@ -291,10 +291,10 @@ def build(db: BeaverDB) -> FastAPI:
         collection = db.collection(name)
         try:
             results = collection.search(vector=req.vector, top_k=req.top_k)
-            return [{"document": doc.model_dump(), "distance": dist} for doc, dist in results]
+            return [{"document": doc.to_dict(), "distance": dist} for doc, dist in results]
         except TypeError as e:
-            if "faiss" in str(e):
-                raise HTTPException(status_code=501, detail="Vector search requires the '[faiss]' extra. Install with: pip install \"beaver-db[faiss]\"")
+            if "vector" in str(e):
+                raise HTTPException(status_code=501, detail="Vector search requires the '[vector]' extra. Install with: pip install \"beaver-db[vector]\"")
             raise e
 
     @app.post("/collections/{name}/match", tags=["Collections"])
@@ -302,7 +302,7 @@ def build(db: BeaverDB) -> FastAPI:
         """Performs a full-text or fuzzy search on the collection."""
         collection = db.collection(name)
         results = collection.match(query=req.query, on=req.on, top_k=req.top_k, fuzziness=req.fuzziness)
-        return [{"document": doc.model_dump(), "score": score} for doc, score in results]
+        return [{"document": doc.to_dict(), "score": score} for doc, score in results]
 
     @app.post("/collections/{name}/connect", tags=["Collections"])
     def connect_documents(name: str, req: ConnectRequest):
@@ -319,7 +319,7 @@ def build(db: BeaverDB) -> FastAPI:
         collection = db.collection(name)
         doc = Document(id=doc_id)
         neighbors = collection.neighbors(doc, label=label)
-        return [n.model_dump() for n in neighbors]
+        return [n.to_dict() for n in neighbors]
 
     @app.post("/collections/{name}/{doc_id}/walk", tags=["Collections"])
     def walk_graph(name: str, doc_id: str, req: WalkRequest) -> List[dict]:
@@ -327,7 +327,7 @@ def build(db: BeaverDB) -> FastAPI:
         collection = db.collection(name)
         source_doc = Document(id=doc_id)
         results = collection.walk(source=source_doc, labels=req.labels, depth=req.depth, direction=req.direction)
-        return [doc.model_dump() for doc in results]
+        return [doc.to_dict() for doc in results]
 
     return app
 

{beaver_db-0.17.6.dist-info → beaver_db-0.18.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beaver-db
-Version: 0.17.6
+Version: 0.18.1
 Summary: Fast, embedded, and multi-modal DB based on SQLite for AI-powered applications.
 License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
@@ -93,7 +93,7 @@ To include optional features, you can install them as extras:
 
 ```bash
 # For vector search capabilities
-pip install "beaver-db[faiss]"
+pip install "beaver-db[vector]"
 
 # For the REST API server and CLI
 pip install "beaver-db[server,cli]"
@@ -102,6 +102,16 @@ pip install "beaver-db[server,cli]"
 pip install "beaver-db[full]"
 ```
 
+### Running with Docker
+For a fully embedded and lightweight solution, you can run the BeaverDB REST API server using Docker. This is the easiest way to get a self-hosted instance up and running.
+
+```bash
+docker run -p 8000:8000 -v $(pwd)/data:/app apiad/beaverdb
+```
+
+This command will start the BeaverDB server, and your database file will be stored in the data directory on your host machine. You can access the API at <http://localhost:8000>.
+
+
 ## Quickstart
 
 Get up and running in 30 seconds. This example showcases a dictionary, a list, and full-text search in a single script.
@@ -401,6 +411,8 @@ For more in-depth examples, check out the scripts in the `examples/` directory:
 These are some of the features and improvements planned for future releases:
 
 - **Async API**: Extend the async support with on-demand wrappers for all features besides channels.
+- **Type-Safe Models**: Enhance built-in `Model` to handle recursive and embedded types.
+- **Drop-in REST Client**: Implement a `BeaverClient` class that acts as a drop-in replacement for `BeaverDB` but instead of a local database file, it works against a REST API server.
 
 Check out the [roadmap](roadmap.md) for a detailed list of upcoming features and design ideas.
 
@@ -408,4 +420,4 @@ If you think of something that would make `beaver` more useful for your use case
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.

{beaver_db-0.17.6.dist-info → beaver_db-0.18.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
-beaver/__init__.py,sha256=qyEzF1Os7w4b4Hijgz0Y0R4zTrRBrHIGT1mEkZFl2YM,101
+beaver/__init__.py,sha256=QkP3H8ah0QpWqaryT3yjNFX07zjGHMoWgu4dWDHH9eQ,125
 beaver/blobs.py,sha256=YkIEskHD6oHRaJTF0P25HrTT8LqM-REyV_UBPVQxeqQ,4055
 beaver/channels.py,sha256=kIuwKMDBdDQObaKT23znsMXzfpKfE7pXSxvf-u4LlpY,9554
-beaver/cli.py,sha256=Q61OYGrsWzERKy69NbttlSLUh1JunPlDSAd__LeKxhM,1789
-beaver/collections.py,sha256=Wm684pGp-E89PCq9gcbbmRC9VMtTxolRVXnrxKlw2m8,24615
+beaver/cli.py,sha256=Sxm-mYU3LGd4tIqw-5LHb0ektWebjV9vn51hm-CMJD0,2232
+beaver/collections.py,sha256=CBJSBmJ0LuVI068iRJ2HCXdivxjw51FJOu2BC_54Lfw,24825
 beaver/core.py,sha256=68vjuEbkJTHv4SltCLCrgs34BpLCeL602oJZ6CJ34Zo,14560
 beaver/dicts.py,sha256=Xp8lPfQt08O8zCbptQLWQLO79OxG6uAVER6ryj3SScQ,5495
 beaver/lists.py,sha256=rfJ8uTNLkMREYc0uGx0z1VKt2m3eR9hvbdvDD58EbmQ,10140
 beaver/logs.py,sha256=a5xenwl5NZeegIU0dWVEs67lvaHzzw-JRAZtEzNNO3E,9529
 beaver/queues.py,sha256=Fr3oie63EtceSoiC8EOEDSLu1tDI8q2MYLXd8MEeC3g,6476
-beaver/server.py,sha256=OixUvPTIbSYN3anPc98UiF2mM289yjJBQGla1S_HmIY,13556
+beaver/server.py,sha256=ZYbzcar_xQP3vCgvmrRobIx0L8dfcHtvxRAQNcniJwo,13547
 beaver/types.py,sha256=WZLINf7hy6zdKdAFQK0EVMSl5vnY_KnrHXNdXgAKuPg,1582
 beaver/vectors.py,sha256=qvI6RwUOGrhVH5d6PUmI3jKDaoDotMy0iy-bHyvmXks,18496
-beaver_db-0.17.6.dist-info/METADATA,sha256=nfbNnxeVFvBoqoMxvXNAJ_JxMfnLvok_TY32FCFKqsE,20508
-beaver_db-0.17.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-beaver_db-0.17.6.dist-info/entry_points.txt,sha256=bd5E2s45PoBdtdR9-ToKSdLNhmHp8naV1lWP5mOzlrc,42
-beaver_db-0.17.6.dist-info/licenses/LICENSE,sha256=1xrIY5JnMk_QDQzsqmVzPIIyCgZAkWCC8kF2Ddo1UT0,1071
-beaver_db-0.17.6.dist-info/RECORD,,
+beaver_db-0.18.1.dist-info/METADATA,sha256=CbtpFh4hUSpVJEegCeRTpATfZeG81Pgybt1ScCyeEz8,21232
+beaver_db-0.18.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beaver_db-0.18.1.dist-info/entry_points.txt,sha256=bd5E2s45PoBdtdR9-ToKSdLNhmHp8naV1lWP5mOzlrc,42
+beaver_db-0.18.1.dist-info/licenses/LICENSE,sha256=1xrIY5JnMk_QDQzsqmVzPIIyCgZAkWCC8kF2Ddo1UT0,1071
+beaver_db-0.18.1.dist-info/RECORD,,