peercache 0.1.1__tar.gz

peercache-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-rdma-build:
+    name: build (libibverbs) + tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install RDMA dev headers and build tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libibverbs-dev librdmacm-dev cmake ninja-build
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install (builds the C++ extension) + test deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+
+      - name: Verify the extension built with RDMA support
+        run: |
+          python -c "from peercache import _peercache; assert _peercache.HAS_RDMA, 'expected RDMA build'; print('HAS_RDMA', _peercache.HAS_RDMA)"
+
+      - name: Run tests (TCP fallback; runners have no RDMA device)
+        run: pytest -q
+
+  test-no-rdma:
+    name: build (PEERCACHE_NO_RDMA) + tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install without RDMA (stub extension + TCP fallback)
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]" --config-settings=cmake.define.PEERCACHE_NO_RDMA=ON
+      - name: Verify stub build falls back to TCP
+        run: |
+          python -c "from peercache import _peercache; assert _peercache.HAS_RDMA is False; print('stub build OK')"
+      - name: Run tests
+        run: pytest -q

peercache-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "requirements-docs.txt"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+# Allow the workflow to publish to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Only one concurrent Pages deployment.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install docs dependencies
+        run: pip install -r requirements-docs.txt
+      - name: Build site
+        run: mkdocs build --strict --site-dir _site
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

peercache-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,71 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: write   # create the GitHub Release
+
+jobs:
+  build-sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --sdist
+      - name: Check metadata
+        run: |
+          python -m pip install twine
+          python -m twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  github-release:
+    name: Publish GitHub Release
+    needs: build-sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+      - name: Create release and attach the package
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*.tar.gz
+          generate_release_notes: true
+
+  pypi-publish:
+    name: Publish to PyPI (trusted publishing)
+    needs: build-sdist
+    runs-on: ubuntu-latest
+    # Requires a PyPI Trusted Publisher for this repo/workflow:
+    # PyPI project -> Publishing -> add GitHub publisher: flymysql/PeerCache,
+    # workflow release.yml, environment pypi. skip-existing avoids failures when
+    # re-running a tag whose version is already on PyPI.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/peercache/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          skip-existing: true

peercache-0.1.1/.gitignore

@@ -0,0 +1,16 @@
+build/
+dist/
+*.egg-info/
+__pycache__/
+*.py[cod]
+*.so
+.pytest_cache/
+.venv/
+venv/
+*.o
+*.obj
+CMakeCache.txt
+CMakeFiles/
+site/
+.cache/
+_skbuild/

peercache-0.1.1/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to PeerCache are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/) and this project adheres to
+[Semantic Versioning](https://semver.org/).
+
+## [0.1.1] - 2026-05-31
+
+### Changed
+- **Embedded meta**: removed the requirement for a separate meta process. The
+  node whose IP equals `discovery_addr` now auto-hosts the discovery service
+  in-process; co-located nodes that cannot bind the port fall back to client
+  mode automatically. Adds `PeerCacheConfig.meta_bind_host` and
+  `NodeRuntime.is_meta`.
+
+### Added
+- Bilingual (English / 中文) documentation with a language switcher
+  (`mkdocs-static-i18n`).
+
+## [0.1.0] - 2026-05-31
+
+Initial release.
+
+### Added
+- **Decentralized architecture**: a single meta node for service discovery only,
+  plus a consistent-hash distributed directory (DHT) sharded across nodes -- no
+  centralized master or metadata service.
+- **C++ RDMA data plane** (`cpp/`): raw `libibverbs` + TCP QP bootstrap, RC QPs,
+  one-sided `IBV_WR_RDMA_READ`, shared CQ polling, lazy per-peer connection
+  pooling, exposed to Python via `pybind11` (`_peercache`).
+- **Two-MR model**: receive MR (`mem_pool_host.kv_buffer`) as READ destination +
+  backend-owned published pool (LRU, eviction deletes the directory entry).
+- **`PeerCacheStore`**: a SGLang `HiCacheStorage` backend with the v1 zero-copy
+  paths (`batch_set_v1` / `batch_get_v1` / `batch_exists`), the v2 hybrid-pool
+  paths, and the single-key/batch APIs. Mooncake-compatible key suffixing
+  (MHA `_k`/`_v`, MLA single key).
+- **Zero-touch SGLang integration** via the `dynamic` backend mechanism.
+- **TCP fallback transport** for functional testing without RDMA hardware.
+- Service discovery, consistent-hash ring, directory client/server, and a
+  lightweight TCP RPC.
+- MkDocs SDK documentation site and GitHub Actions for CI, docs, and release.
+
+[0.1.1]: https://github.com/flymysql/PeerCache/releases/tag/v0.1.1
+[0.1.0]: https://github.com/flymysql/PeerCache/releases/tag/v0.1.0

peercache-0.1.1/CMakeLists.txt

@@ -0,0 +1,53 @@
+cmake_minimum_required(VERSION 3.18)
+project(peercache LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# Use GNU extensions (-std=gnu++17) so POSIX/SVID symbols (sockets, etc.) are
+# exposed; _GNU_SOURCE below makes this robust even under strict -std=c++17.
+set(CMAKE_CXX_EXTENSIONS ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+option(PEERCACHE_NO_RDMA "Build without libibverbs/librdmacm (stub transport)" OFF)
+
+find_package(pybind11 CONFIG REQUIRED)
+
+# Try to locate the RDMA core libraries unless explicitly disabled.
+if(NOT PEERCACHE_NO_RDMA)
+  find_library(IBVERBS_LIB ibverbs)
+  find_library(RDMACM_LIB rdmacm)
+  find_path(IBVERBS_INCLUDE infiniband/verbs.h)
+  find_path(RDMACM_INCLUDE rdma/rdma_cma.h)
+  if(NOT IBVERBS_LIB OR NOT RDMACM_LIB OR NOT IBVERBS_INCLUDE OR NOT RDMACM_INCLUDE)
+    message(WARNING
+      "libibverbs/librdmacm not found; building PeerCache C++ module in STUB mode. "
+      "The pure-Python TCP fallback transport will be used at runtime.")
+    set(PEERCACHE_NO_RDMA ON)
+  endif()
+endif()
+
+set(PEERCACHE_SOURCES cpp/bindings/pybind.cpp)
+
+if(NOT PEERCACHE_NO_RDMA)
+  list(APPEND PEERCACHE_SOURCES
+    cpp/src/rdma_context.cpp
+    cpp/src/rdma_endpoint.cpp
+    cpp/src/connection_manager.cpp
+    cpp/src/transfer_engine.cpp)
+endif()
+
+pybind11_add_module(_peercache ${PEERCACHE_SOURCES})
+target_include_directories(_peercache PRIVATE cpp/include)
+
+if(PEERCACHE_NO_RDMA)
+  target_compile_definitions(_peercache PRIVATE PEERCACHE_NO_RDMA=1)
+else()
+  # _GNU_SOURCE exposes POSIX socket APIs and SVID helpers regardless of the
+  # active -std level (it must be defined before any system header is included,
+  # which a compile definition guarantees).
+  target_compile_definitions(_peercache PRIVATE _GNU_SOURCE)
+  target_include_directories(_peercache PRIVATE ${IBVERBS_INCLUDE} ${RDMACM_INCLUDE})
+  target_link_libraries(_peercache PRIVATE ${IBVERBS_LIB} ${RDMACM_LIB} pthread)
+endif()
+
+install(TARGETS _peercache LIBRARY DESTINATION peercache)

peercache-0.1.1/LICENSE

@@ -0,0 +1,190 @@
+                                 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.
+
+      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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 PeerCache contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

peercache-0.1.1/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.2
+Name: peercache
+Version: 0.1.1
+Summary: Peer-to-peer RDMA zero-copy L3 KV-cache backend for SGLang HiCache
+Author: PeerCache contributors
+License: Apache-2.0
+Requires-Python: >=3.9
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: fast
+Requires-Dist: msgpack>=1.0; extra == "fast"
+Description-Content-Type: text/markdown
+
+# PeerCache
+
+[![CI](https://github.com/flymysql/PeerCache/actions/workflows/ci.yml/badge.svg)](https://github.com/flymysql/PeerCache/actions/workflows/ci.yml)
+[![Docs](https://github.com/flymysql/PeerCache/actions/workflows/docs.yml/badge.svg)](https://flymysql.github.io/PeerCache/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+A lightweight, peer-to-peer **L3 storage backend for SGLang HiCache**.
+
+Docs: <https://flymysql.github.io/PeerCache/>
+
+PeerCache gives you Mooncake-style RDMA zero-copy KV-cache sharing across nodes,
+but **without** the centralized `master` + `metadata` services. Instead it uses:
+
+- **Embedded service discovery** — no separate meta process. One node (chosen by
+  `discovery_addr`) auto-hosts the discovery service in-process; nodes register
+  their endpoint, heartbeat, and pull the live membership list.
+- **A consistent-hash distributed directory (DHT)** — the mapping
+  `key -> {data_node, remote_addr, rkey, length}` is sharded across all nodes by
+  hashing the key. There is no central metadata store.
+- **Data stays local on write** — `set()` copies the page into a node-local
+  *published pool* (a host memcpy, no network, no master) and pushes only a tiny
+  location record to the directory.
+- **One-sided RDMA READ on read** — `get()` looks up the directory, then issues a
+  zero-copy `IBV_WR_RDMA_READ` straight into SGLang's registered host buffer.
+
+```
+write:  set() ── local memcpy ──> published pool MR
+                └── PUT key->{node,addr,rkey,len} ──> directory shard (hash(key))
+read:   get() ── GET key ──> directory shard ──> {node,addr,rkey,len}
+                └── one-sided RDMA READ ──> local host buffer (zero copy)
+```
+
+## Why simpler than Mooncake?
+
+| | Mooncake | PeerCache |
+|---|---|---|
+| metadata | central master + metadata service | sharded directory (consistent hash) |
+| data placement | dedicated managed pool | stays on producing node |
+| coordination | master allocates / tracks objects | only service discovery on meta node |
+| transfer | RDMA zero-copy | RDMA zero-copy (one-sided READ) |
+
+## Architecture
+
+- **C++ data plane** (`cpp/`): raw `libibverbs` + `librdmacm`. RC QPs, one-sided
+  READ/WRITE, CQ polling, lazy per-peer connection pooling. Exposed to Python via
+  `pybind11` as the `_peercache` module.
+- **Python control plane** (`python/peercache/`): TCP RPC, service discovery,
+  consistent-hash ring, distributed directory, and the published-pool with LRU.
+- **TCP fallback transport**: a pure-Python transport that mirrors the RDMA API so
+  the design can be validated end-to-end on machines without RDMA hardware.
+
+## Two-MR model (correctness)
+
+SGLang's host KV buffer is the L2 tier and is evicted/overwritten by HiCache, so we
+cannot register *its* address into the directory directly (dangling reference). Each
+node therefore registers **two memory regions**:
+
+1. **Receive MR** = `mem_pool_host.kv_buffer` — destination of one-sided READ on `get`.
+2. **Published pool MR** = a backend-owned host pool with LRU — source of READ on
+   remote nodes. `set` memcpys the page into this pool (node-local, no network) and
+   publishes its `addr+rkey+len` to the directory. Eviction from the pool deletes the
+   corresponding directory entry, so a published address stays valid until evicted.
+
+## Install
+
+```bash
+# Linux with RDMA (Mellanox OFED / rdma-core dev headers installed)
+pip install .
+
+# Without RDMA (control-plane + TCP fallback only, e.g. for tests on a laptop)
+pip install -e . --config-settings=cmake.define.PEERCACHE_NO_RDMA=ON
+```
+
+## Run with SGLang
+
+The meta service is **embedded** — there is no separate meta process. Point
+`discovery_addr` at one node's IP on every node; the node whose IP matches
+auto-starts the discovery service in-process.
+
+```bash
+# On every SGLang node, set discovery_addr to the SAME node's IP (say node-0).
+# node-0 detects the IP is itself and hosts the embedded meta automatically.
+python -m sglang.launch_server --enable-hierarchical-cache \
+  --hicache-storage-backend dynamic \
+  --hicache-storage-backend-extra-config \
+  '{"backend_name":"peercache","module_path":"peercache.store","class_name":"PeerCacheStore","discovery_addr":"NODE0_IP:9100","protocol":"rdma","device_name":"mlx5_0","global_segment_size":"4gb"}'
+```
+
+(Optionally, you can still run a standalone meta with `peercache-meta --bind
+0.0.0.0:9100` if you prefer a dedicated discovery host.)
+
+See [examples/sglang_launch.md](examples/sglang_launch.md) for details.
+
+## Test
+
+```bash
+pip install pytest
+PYTHONPATH=python pytest tests/ -v
+```
+
+## Maintainer setup (one-time)
+
+- **GitHub Pages**: Settings → Pages → Build and deployment → Source = **GitHub
+  Actions**. The `Docs` workflow then publishes to
+  <https://flymysql.github.io/PeerCache/> on every push to `main`.
+- **PyPI Trusted Publishing**: on the PyPI `peercache` project, add a GitHub
+  publisher (owner `flymysql`, repo `PeerCache`, workflow `release.yml`,
+  environment `pypi`). Tagging `vX.Y.Z` then builds the sdist, attaches it to a
+  GitHub Release, and publishes to PyPI. Until configured, the PyPI step is
+  non-blocking and the GitHub Release still ships the package.