Tubox Client

The Next-Gen Python Client for Tubox Database

Features • Quick Start • Architecture • Examples • Documentation

Tubox Client is a high-performance, production-ready Python library designed to interact with the Tubox database. Built with a philosophy of "Simple by default, powerful when needed," it offers both a developer-friendly synchronous API and a high-throughput asynchronous core.

🚀 Features at a Glance

📦 Installation

pip install tubox-client

🏎️ Quick Start

Get up and running in seconds.

Synchronous (Standard)

Perfect for scripts, data analysis, and standard web apps (Django, Flask).

from tubox_client import TuboxClient

# 1. Connect
with TuboxClient("localhost", 7188, "admin", "password") as client:
    db = client["my_app"]
    users = db["users"]
    
    # 2. Insert
    users.insert_one({"name": "Alice", "role": "developer"})
    
    # 3. Query
    for user in users.find({"role": "developer"}).documents:
        print(f"Found developer: {user['name']}")

Asynchronous (High Performance)

Built for speed.

import asyncio
from tubox_client import TuboxAPIClient

async def main():
    client = TuboxAPIClient("localhost", 7188)
    await client.connect()
    await client.authenticate("admin", "password")
    
    await client["my_app"]["logs"].insert_one({"event": "login"})
    
    await client.close()

asyncio.run(main())

🏗️ Architecture

Tubox Client is built on a layered architecture to separate concerns and ensure reliability.

The Sync Wrapper manages a dedicated event loop to bridge standard Python code with the Async Core, which handles the heavy lifting of connection management and protocol serialization.

For a deep dive, see ARCHITECTURE.md.

💡 Examples

We have a comprehensive suite of examples to cover every use case:

📚 Documentation

Full documentation is available at https://tubox.cloud/.

📜 License

This project is licensed under the MIT License.