Skip to main content

YukisDB Python SDK & CLI ⚡

PyPI version License: MIT

Official Python SDK & Developer CLI for YukisDB — Unified Cloud NoSQL JSON Document Database, 2GB Object Storage with Zero Egress Bandwidth Bills, and AI Vector Embeddings Memory.


📦 Installation

pip install yukisdb

💻 CLI Quickstart

Once installed, the yukisdb command is immediately available in your terminal:

# Check cluster telemetry & health
yukisdb health

# View developer free tier quotas
yukisdb tier

# Zero-auth sandbox insert
yukisdb sandbox insert '{"task": "test", "completed": true}'

# Zero-auth sandbox query
yukisdb sandbox find '{"completed": true}'

# Generate an ephemeral API testing key
yukisdb anonymous-key

# Authenticated CRUD (requires export YUKISDB_API_KEY=ydb_live_...)
export YUKISDB_API_KEY="ydb_live_your_key_here"
yukisdb insert users '{"name": "Sudeep", "role": "admin"}'
yukisdb find users '{"role": "admin"}'
yukisdb upload model_checkpoint.pt

🐍 Python SDK Quickstart

1. Initialize Client

from yukisdb import YukisDB

# Automatically picks up YUKISDB_API_KEY environment variable if omitted
db = YukisDB(api_key="ydb_live_your_api_key_here")

2. NoSQL Document Operations (CRUD)

# Insert a document
doc = db.collection("users").insert({
    "name": "Alice",
    "email": "alice@example.com",
    "tier": "developer"
})
print("Inserted ID:", doc["id"])

# Query documents
users = db.collection("users").find({"tier": "developer"})
print("Found users:", users)

# Retrieve single document by ID
user = db.collection("users").get(doc["id"])

# Update document
db.collection("users").update(doc["id"], {"tier": "pro"})

# Delete document
db.collection("users").delete(doc["id"])

3. AI Vector Embeddings Search

# Cosine similarity nearest-neighbor search for agent long-term memory
results = db.collection("agent_memory").vector_search(
    vector=[0.12, -0.45, 0.88, 0.05],
    field="embedding",
    top_k=5
)
for match in results:
    print(match["title"], match["_score"])

4. 2GB Object Storage (Zero Egress Bills)

# Upload any file up to 2GB with instant CDN streaming URL
file_info = db.storage.upload("video_dataset.mp4", custom_slug="dataset-2026")
print("Public CDN URL:", file_info["url"])

# List tenant storage files
files = db.storage.list()
print("Storage objects:", files)

5. Zero-Auth Public Sandbox (Prototyping)

# Store without registration
sandbox_doc = db.sandbox.insert({"experiment": "RAG pipeline test"})
print("Saved to sandbox:", sandbox_doc)

🤖 Model Context Protocol (MCP) Integration

YukisDB runs a native Model Context Protocol (MCP 2024-11-05) server for Claude Desktop, Cursor AI, and autonomous agents:

{
  "mcpServers": {
    "yukisdb": {
      "command": "yukisdb",
      "args": ["mcp"],
      "env": {
        "YUKISDB_API_KEY": "ydb_live_your_api_key_here"
      }
    }
  }
}

Or connect directly to Streamable HTTP: https://yukisdb.yukiapi.site/mcp.


🔗 Resources

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yukisdb-1.0.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yukisdb-1.0.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file yukisdb-1.0.0.tar.gz.

File metadata

  • Download URL: yukisdb-1.0.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for yukisdb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fdb6b8c6acc50c1c4ce81d0980008ffae4d2a05bb58d33f974fc8eef5c5e933d
MD5 7106f81b01b9e39a8a51fc5d6c1c0301
BLAKE2b-256 f73f49766e43062abd73a856c31082a58f41a40e530fcda1a79203dc3c30fe76

See more details on using hashes here.

File details

Details for the file yukisdb-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: yukisdb-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for yukisdb-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a482652bc1896a8f246d59ce107c4990e69d41c2b2be1be4c2a3775c157e6dd
MD5 883be83442e11745f95cac9dbd74df0c
BLAKE2b-256 980e253c2c08b39f9a637e9740d145e1db80d3bf71adbd9b86406151b27733cb

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.1

2 files

This release

1.0.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page