Skip to content

docs: fix documentation accuracy #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lostmygithubaccount merged 1 commit into from
Apr 4, 2026
Merged

docs: fix documentation accuracy #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading