From 6e02079bed8d62ea032b53bf3e81ad9422fb2ddf Mon Sep 17 00:00:00 2001 From: Cody Date: Fri, 3 Apr 2026 23:05:13 -0400 Subject: [PATCH] docs: fix e2e test path, document API parity and test instructions Co-Authored-By: Claude Opus 4.6 (1M context) --- AGENTS.md | 10 +++++++++- README.md | 2 ++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 2e5d434..862bb64 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,11 +29,19 @@ crates/stringflow-core/ # Core library (stringflow on crates.io) src/wire_formats/messages.rs # Anthropic Messages crates/stringflow-py/ # PyO3 bindings (cdylib) py/stringflow/ # Python wrapper + type stubs -tests/e2e.rs # E2E tests (require running llama-server) +crates/stringflow-core/tests/e2e.rs # E2E tests (require running llama-server) ``` Library only — no binaries. Supports async + blocking + streaming. +## E2E tests + +E2E tests require a running `llama-server` on `localhost:8080`. Run with: + +```bash +cargo test -p stringflow -- --ignored +``` + ## Wire formats - OpenAI Chat Completions (`/v1/chat/completions`) diff --git a/README.md b/README.md index f713508..74e8735 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,5 @@ response = stringflow.chat( messages=[("user", "Hello!")], ) ``` + +> **Note:** Streaming (`chat_stream()`) and async (`chat_async()`) APIs are currently Rust-only. Python provides synchronous `chat()` and `health_check()` only.