Metadata-Version: 2.4
Name: yukisdb
Version: 1.0.0
Summary: Official Python SDK & CLI for YukisDB — Unified Cloud NoSQL Database, 2GB Storage & AI Vector BaaS
Home-page: https://yukisdb.yukiapi.site
Author: SUDEEPBOTS
Author-email: support@yukiapi.site
Project-URL: Documentation, https://yukisdb.yukiapi.site/docs
Project-URL: Source, https://github.com/SUDEEPBOTS/yukisdb
Project-URL: Tracker, https://github.com/SUDEEPBOTS/yukisdb/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.25.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# YukisDB Python SDK & CLI ⚡

[![PyPI version](https://img.shields.io/pypi/v/yukisdb.svg)](https://pypi.org/project/yukisdb/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Official Python SDK & Developer CLI for **[YukisDB](https://yukisdb.yukiapi.site)** — Unified Cloud NoSQL JSON Document Database, 2GB Object Storage with Zero Egress Bandwidth Bills, and AI Vector Embeddings Memory.

---

## 📦 Installation

```bash
pip install yukisdb
```

---

## 💻 CLI Quickstart

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

```bash
# 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

```python
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)

```python
# 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

```python
# 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)

```python
# 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)

```python
# 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:

```json
{
  "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

- **Website & Portal:** [https://yukisdb.yukiapi.site](https://yukisdb.yukiapi.site)
- **Developer Documentation:** [https://yukisdb.yukiapi.site/docs](https://yukisdb.yukiapi.site/docs)
- **OpenAPI 3.1 Spec:** [https://yukisdb.yukiapi.site/openapi.json](https://yukisdb.yukiapi.site/openapi.json)
- **LLMs Knowledge Reference:** [https://yukisdb.yukiapi.site/llms.txt](https://yukisdb.yukiapi.site/llms.txt)
- **Support & Security:** `support@yukiapi.site`
