Metadata-Version: 2.3
Name: k-flow
Version: 0.2.1
Summary: Contract-first voice kernel skeleton with transport wrappers
Author: KpihX
Author-email: KpihX <kapoivha@gmail.com>
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: typer>=0.12.0
Requires-Dist: websockets>=12.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

## flow

Hardware-first voice kernel for local STT/TTS orchestration on Intel-focused workstations.

Current status:

- Contract-first workflow is enforced.
- `CONTRACT.md` is the non-negotiable source of truth for internal API and transport wrappers.
- A modular core and transport adapters are implemented.

## Scope

- Stable internal API surface (`dispatch` + operation set).
- Transport wrappers:
  - CLI (`flow`)
  - stdio JSONL (`flow-stdio`)
  - WebSocket frame processor + server entry (`flow-ws`)
  - MCP tool wrapper mapping (`flow.adapters.mcp`)
- Frozen conventions (types, error codes, event schema).

## Layout

- `CONTRACT.md` — full protocol and API contract (authoritative).
- `src/flow/kernel.py` — stateful kernel implementation.
- `src/flow/core.py` — stable operation facade + dispatch table.
- `src/flow/protocol.py` — envelope validation and request processing.
- `src/flow/adapters/` — modular transport adapters (`cli`, `stdio`, `ws`, `mcp`).
- `.agents/AGENTS.md` — project operating rules for agents.

## Quickstart

- Contract gate:
  - `make contract-test`
- CLI:
  - `uv run flow health --json`
- stdio:
  - `printf '{"schema_version":"flow.contract.v1","request_id":"req1","timestamp_ms":1,"payload":{"op":"health","args":{}}}\n' | uv run flow-stdio`

## Release

- Distribution name: `k-flow` (module import remains `flow`).
- Build and publish:
  - `make release`
- The `push` pipeline bootstraps missing remotes (`github`, `gitlab`) automatically using `gh` + `glab`.
