beaver-db 0.16.8__tar.gz → 0.17.0__tar.gz

{beaver_db-0.16.8 → beaver_db-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beaver-db
-Version: 0.16.8
+Version: 0.17.0
 Summary: Fast, embedded, and multi-modal DB based on SQLite for AI-powered applications.
 License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
@@ -9,8 +9,17 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Database
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Requires-Python: >=3.13
-Provides-Extra: faiss
-Requires-Dist: faiss-cpu>=1.12.0; extra == 'faiss'
+Provides-Extra: cli
+Requires-Dist: typer>=0.19.2; extra == 'cli'
+Provides-Extra: full
+Requires-Dist: faiss-cpu>=1.12.0; extra == 'full'
+Requires-Dist: fastapi[standard]>=0.118.0; extra == 'full'
+Requires-Dist: typer>=0.19.2; extra == 'full'
+Provides-Extra: server
+Requires-Dist: fastapi[standard]>=0.118.0; extra == 'server'
+Requires-Dist: typer>=0.19.2; extra == 'server'
+Provides-Extra: vector
+Requires-Dist: faiss-cpu>=1.12.0; extra == 'vector'
 Description-Content-Type: text/markdown
 
 # beaver 🦫

beaver_db-0.17.0/beaver/cli.py

@@ -0,0 +1,34 @@
+import typer
+import rich
+
+app = typer.Typer()
+
+
+@app.command()
+def serve(
+    database: str = typer.Option(
+        "beaver.db", "--database", "-d", help="Path to the database file."
+    ),
+    host: str = typer.Option(
+        "127.0.0.1", "--host", "-h", help="The host to bind the server to."
+    ),
+    port: int = typer.Option(
+        8000, "--port", "-p", help="The port to run the server on."
+    ),
+):
+    """
+    Starts a RESTful API server for a BeaverDB instance.
+    """
+    try:
+        from .server import serve as run_server
+    except ImportError as e:
+        rich.print(f"[red]Error: {e}[/]")
+        rich.print('[yellow]Please install the server dependencies with `pip install "beaver-db[server]"`[/]')
+        raise typer.Exit(code=1)
+
+    rich.print(f"[blue]Starting server for database at '{database}' on http://{host}:{port}[/]")
+    run_server(db_path=database, host=host, port=port)
+
+
+if __name__ == "__main__":
+    app()

beaver_db-0.17.0/beaver/server.py

@@ -0,0 +1,132 @@
+try:
+    from fastapi import FastAPI, HTTPException, Body
+    import uvicorn
+except ImportError:
+    raise ImportError(
+        "FastAPI and Uvicorn are required to serve the database. "
+        'Please install them with `pip install "beaver-db[server]"`'
+    )
+from typing import Any
+from .core import BeaverDB
+
+
+def build(db: BeaverDB) -> FastAPI:
+    """
+    Constructs a FastAPI application instance for a given BeaverDB instance.
+
+    Args:
+        db: An active BeaverDB instance.
+
+    Returns:
+        A FastAPI application with all endpoints configured.
+    """
+    app = FastAPI(
+        title="BeaverDB",
+        description="A RESTful API for a BeaverDB instance.",
+        version="0.1.0",
+    )
+
+    # --- Dicts Endpoints ---
+
+    @app.get("/dicts/{name}")
+    def get_all_dict_items(name: str) -> dict:
+        """Retrieves all key-value pairs in a dictionary."""
+        d = db.dict(name)
+        return {k: v for k, v in d.items()}
+
+    @app.get("/dicts/{name}/{key}")
+    def get_dict_item(name: str, key: str) -> Any:
+        """Retrieves the value for a specific key."""
+        d = db.dict(name)
+        try:
+            return d[key]
+        except KeyError:
+            raise HTTPException(status_code=404, detail=f"Key '{key}' not found in dictionary '{name}'")
+
+    @app.post("/dicts/{name}/{key}")
+    def set_dict_item(name: str, key: str, value: Any = Body(...)):
+        """Sets the value for a specific key."""
+        d = db.dict(name)
+        d[key] = value
+        return {"status": "ok"}
+
+    @app.delete("/dicts/{name}/{key}")
+    def delete_dict_item(name: str, key: str):
+        """Deletes a key-value pair."""
+        d = db.dict(name)
+        try:
+            del d[key]
+            return {"status": "ok"}
+        except KeyError:
+            raise HTTPException(status_code=404, detail=f"Key '{key}' not found in dictionary '{name}'")
+
+    # --- Lists Endpoints ---
+
+    @app.get("/lists/{name}")
+    def get_list(name: str) -> list:
+        """Retrieves all items in the list."""
+        l = db.list(name)
+        return l[:]
+
+    @app.get("/lists/{name}/{index}")
+    def get_list_item(name: str, index: int) -> Any:
+        """Retrieves the item at a specific index."""
+        l = db.list(name)
+        try:
+            return l[index]
+        except IndexError:
+            raise HTTPException(status_code=404, detail=f"Index {index} out of bounds for list '{name}'")
+
+    @app.post("/lists/{name}")
+    def push_list_item(name: str, value: Any = Body(...)):
+        """Adds an item to the end of the list."""
+        l = db.list(name)
+        l.push(value)
+        return {"status": "ok"}
+
+    @app.put("/lists/{name}/{index}")
+    def update_list_item(name: str, index: int, value: Any = Body(...)):
+        """Updates the item at a specific index."""
+        l = db.list(name)
+        try:
+            l[index] = value
+            return {"status": "ok"}
+        except IndexError:
+            raise HTTPException(status_code=404, detail=f"Index {index} out of bounds for list '{name}'")
+
+    @app.delete("/lists/{name}/{index}")
+    def delete_list_item(name: str, index: int):
+        """Deletes the item at a specific index."""
+        l = db.list(name)
+        try:
+            del l[index]
+            return {"status": "ok"}
+        except IndexError:
+            raise HTTPException(status_code=404, detail=f"Index {index} out of bounds for list '{name}'")
+
+    # TODO: Add endpoints for all BeaverDB modalities
+    # - Queues
+    # - Collections
+    # - Channels
+    # - Logs
+    # - Blobs
+
+    @app.get("/")
+    def read_root():
+        return {"message": "Welcome to the BeaverDB API"}
+
+    return app
+
+
+def serve(db_path: str, host: str, port: int):
+    """
+    Initializes a BeaverDB instance and runs a Uvicorn server for it.
+
+    Args:
+        db_path: The path to the SQLite database file.
+        host: The host to bind the server to.
+        port: The port to run the server on.
+    """
+    db = BeaverDB(db_path)
+    app = build(db)
+    uvicorn.run(app, host=host, port=port)

{beaver_db-0.16.8 → beaver_db-0.17.0}/examples/fts.py

@@ -64,9 +64,9 @@ def full_text_search_demo():
 
     # --- 3. Perform a Targeted Full-Text Search on a Specific Field ---
 
-    # Now, we search for "Jane" but ONLY in the flattened 'author__name' field.
+    # Now, we search for "Jane" but ONLY in the flattened 'author.name' field.
     # This should return only the documents by Jane Doe (doc1 and doc3).
-    print("\n--- Specific Search for 'Jane' in the 'author__name' field ---")
+    print("\n--- Specific Search for 'Jane' in the 'author.name' field ---")
     specific_results = articles.match("Jane", on="author.name", top_k=5)
 
     for doc, rank in specific_results:

{beaver_db-0.16.8 → beaver_db-0.17.0}/makefile

@@ -5,7 +5,7 @@ publish: clean build
 .PHONY: build
 build:
 	uv build
-	uv pip install -e .[faiss]
+	uv pip install -e .[all]
 
 .PHONY: clean
 clean:

{beaver_db-0.16.8 → beaver_db-0.17.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "beaver-db"
-version = "0.16.8"
+version = "0.17.0"
 description = "Fast, embedded, and multi-modal DB based on SQLite for AI-powered applications."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -12,6 +12,9 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Application Frameworks",
 ]
 
+[project.scripts]
+beaver = "beaver.cli:app"
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -20,9 +23,10 @@ build-backend = "hatchling.build"
 packages = ["beaver"]
 
 [project.optional-dependencies]
-faiss = ["faiss-cpu>=1.12.0"]
+vector = ["faiss-cpu>=1.12.0"]
+server = ["fastapi[standard]>=0.118.0", "typer>=0.19.2"]
+cli = ["typer>=0.19.2"]
+full = ["faiss-cpu>=1.12.0", "fastapi[standard]>=0.118.0", "typer>=0.19.2"]
 
 [dependency-groups]
-dev = [
-    "textual>=6.1.0",
-]
+dev = ["textual>=6.1.0"]