Skip to main content

Contract-first voice kernel skeleton with transport wrappers

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k_flow-0.2.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k_flow-0.2.1-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file k_flow-0.2.1.tar.gz.

File metadata

  • Download URL: k_flow-0.2.1.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for k_flow-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1697ead5f9d78de80abdb342f11327ef7106f288499fcf08ce51779225065f9a
MD5 d135ccf864bcbc7bf54e3f7495f45915
BLAKE2b-256 fa85c8f6061f0bca6ecefaaa22283b2b82ddcc98071b92f92ad86e99042cc8bb

See more details on using hashes here.

File details

Details for the file k_flow-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: k_flow-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for k_flow-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9ba09fa46f4958ff90ba3801ec32f85878850081673724a3f924e2c41129ef4
MD5 f64268f3837aa65ac57d8c54bbf347b5
BLAKE2b-256 7d6fb8942080d7ec5177ec78ce28b02f81735d742e3995415b26e29689a59e24

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page