kachedb 0.1.0a2__tar.gz

kachedb-0.1.0a2/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Ruff check
+        run: ruff check src/ tests/
+
+      - name: Ruff format check
+        run: ruff format --check src/ tests/
+
+      - name: Mypy type check
+        run: mypy src/kachedb/
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run unit tests
+        run: pytest tests/ -v --ignore=tests/test_integration.py -x

kachedb-0.1.0a2/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write  # Required for Trusted Publisher (OIDC)
+
+jobs:
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/kachedb/
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

kachedb-0.1.0a2/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+
+# OS
+.DS_Store
+Thumbs.db

kachedb-0.1.0a2/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

kachedb-0.1.0a2/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vubon Roy and KacheDB Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kachedb-0.1.0a2/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.5
+Name: kachedb
+Version: 0.1.0a2
+Summary: High-performance Python client for KacheDB — the zero-copy Redis-compatible & LLM KV-cache storage engine
+Project-URL: Homepage, https://github.com/vubon/kachedb-py
+Project-URL: Repository, https://github.com/vubon/kachedb-py
+Project-URL: Documentation, https://github.com/vubon/kachedb-py#readme
+Project-URL: Bug Tracker, https://github.com/vubon/kachedb-py/issues
+Project-URL: KacheDB Server, https://github.com/vubon/kachedb
+Author: KacheDB Core Team
+License-Expression: Apache-2.0 OR MIT
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Keywords: cache,kachedb,kv-cache,llm,redis,tensor,vllm,zero-copy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.24
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: torch
+Requires-Dist: torch>=2.0; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# kachedb
+
+<p align="center">
+  <strong>High-Performance Python Client for KacheDB — The Zero-Copy Redis-Compatible & LLM KV-Cache Storage Engine</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/kachedb/"><img src="https://img.shields.io/pypi/v/kachedb.svg" alt="PyPI Version"/></a>
+  <a href="https://pypi.org/project/kachedb/"><img src="https://img.shields.io/pypi/pyversions/kachedb.svg" alt="Python Versions"/></a>
+  <a href="https://github.com/vubon/kachedb-py/actions"><img src="https://github.com/vubon/kachedb-py/actions/workflows/ci.yml/badge.svg" alt="CI"/></a>
+  <a href="https://github.com/vubon/kachedb-py/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/license-Apache--2.0%20%2F%20MIT-blue.svg" alt="License"/></a>
+</p>
+
+---
+
+## ⚡ Installation
+
+```bash
+pip install kachedb
+```
+
+With PyTorch tensor support:
+
+```bash
+pip install kachedb[torch]
+```
+
+## 🚀 Quickstart
+
+### Synchronous Client
+
+```python
+from kachedb import KacheClient
+
+with KacheClient(host="127.0.0.1", port=6379) as client:
+    # Standard Redis-compatible operations
+    client.set("user:1", "alice", ex=3600)     # SET with 1-hour TTL
+    print(client.get("user:1"))                 # b"alice"
+
+    # Batch operations
+    client.set("user:2", "bob")
+    result = client.mget("user:1", "user:2")    # [b"alice", b"bob"]
+
+    # Check existence
+    print(client.exists("user:1"))              # 1
+
+    # Delete
+    client.delete("user:1", "user:2")
+```
+
+### Async Client
+
+```python
+import asyncio
+from kachedb import AsyncKacheClient
+
+async def main():
+    async with AsyncKacheClient(host="127.0.0.1", port=6379) as client:
+        await client.set("key", "value", ex=60)
+        result = await client.get("key")
+        print(result)  # b"value"
+
+asyncio.run(main())
+```
+
+### Pipeline Batching
+
+Reduce network round-trips by batching multiple commands:
+
+```python
+from kachedb import KacheClient
+
+with KacheClient() as client:
+    pipe = client.pipeline()
+    pipe.set("a", "1")
+    pipe.set("b", "2")
+    pipe.set("c", "3")
+    pipe.get("a")
+    pipe.get("b")
+    pipe.get("c")
+
+    results = pipe.execute()
+    # ["OK", "OK", "OK", b"1", b"2", b"3"]
+```
+
+### Async Pipeline
+
+```python
+from kachedb import AsyncKacheClient
+
+async def main():
+    async with AsyncKacheClient() as client:
+        pipe = client.pipeline()
+        pipe.set("x", "10")
+        pipe.get("x")
+        results = await pipe.execute()
+        # ["OK", b"10"]
+```
+
+### Zero-Copy Tensor Access (LLM KV-Cache)
+
+Read KV-cache tensors directly from KacheDB's shared memory with **zero data copying**:
+
+```python
+from kachedb import read_tensor, read_torch_tensor
+
+# Read as numpy array (zero-copy via /dev/shm)
+np_tensor = read_tensor(core_id=0, byte_offset=0)
+print(np_tensor.shape, np_tensor.dtype)
+
+# Read as PyTorch tensor (requires: pip install kachedb[torch])
+torch_tensor = read_torch_tensor(core_id=0, byte_offset=0)
+print(torch_tensor.shape, torch_tensor.dtype)
+```
+
+## 📋 Supported Commands
+
+All commands follow the [KacheDB RESP2/RESP3 wire protocol](https://github.com/vubon/kachedb):
+
+| Command | Method | Description |
+| :--- | :--- | :--- |
+| `PING` | `client.ping()` | Test server liveness |
+| `SET` | `client.set(key, value, ex=, px=)` | Store value with optional TTL |
+| `GET` | `client.get(key)` | Retrieve value |
+| `MGET` | `client.mget(*keys)` | Batch retrieve multiple keys |
+| `DEL` | `client.delete(*keys)` | Delete keys |
+| `EXISTS` | `client.exists(*keys)` | Count existing keys |
+
+## 🏗️ Architecture
+
+```text
+┌──────────────────────────────────────────────────────────┐
+│                     Your Python App                      │
+│             (vLLM / SGLang / FastAPI / etc.)             │
+├──────────────────────────────────────────────────────────┤
+│                   kachedb Python SDK                     │
+│  ┌──────────────┐  ┌──────────────┐  ┌────────────────┐  │
+│  │ KacheClient  │  │  AsyncKache  │  │    Pipeline    │  │
+│  │  (sync TCP)  │  │    Client    │  │    Batching    │  │
+│  └──────┬───────┘  └──────┬───────┘  └───────┬────────┘  │
+│         │                 │                  │           │
+│  ┌──────┴─────────────────┴──────────────────┴────────┐  │
+│  │            RESP2/RESP3 Protocol Engine             │  │
+│  │         (64KB buffered encoder + decoder)          │  │
+│  └──────────────────────┬─────────────────────────────┘  │
+│                         │                                │
+│  ┌──────────────────────┴─────────────────────────────┐  │
+│  │        ConnectionPool / AsyncConnectionPool        │  │
+│  │    (Thread-safe / asyncio.Queue, health checks)    │  │
+│  └──────────────────────┬─────────────────────────────┘  │
+├─────────────────────────┼────────────────────────────────┤
+│                   TCP + /dev/shm                         │
+├──────────────────────────────────────────────────────────┤
+│                  KacheDB Server (Rust)                   │
+│         io_uring / kqueue │ POSIX SHM │ Megaslab         │
+└──────────────────────────────────────────────────────────┘
+```
+
+## 🔧 Connection Pool
+
+The client automatically manages a connection pool:
+
+```python
+from kachedb import KacheClient
+
+# Pool with up to 20 connections
+client = KacheClient(
+    host="127.0.0.1",
+    port=6379,
+    max_connections=20,
+    socket_timeout=5.0,
+)
+```
+
+## 🧪 Development
+
+```bash
+# Clone
+git clone https://github.com/vubon/kachedb-py.git
+cd kachedb-py
+
+# Install in dev mode
+pip install -e ".[dev]"
+
+# Run unit tests
+pytest tests/ -v --ignore=tests/test_integration.py
+
+# Run integration tests (requires running KacheDB server)
+pytest tests/test_integration.py -v
+
+# Lint
+ruff check src/ tests/
+ruff format --check src/ tests/
+
+# Type check
+mypy src/kachedb/
+```
+
+## 🔗 Related Projects
+
+- **[KacheDB Server](https://github.com/vubon/kachedb)** — The Rust storage engine
+
+## 📄 License
+
+Dual-licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))
+- MIT license ([LICENSE-MIT](LICENSE-MIT))
+
+at your option.