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.2.tar.gz (6.3 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.2-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: k_flow-0.2.2.tar.gz
  • Upload date:
  • Size: 6.3 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.2.tar.gz
Algorithm Hash digest
SHA256 90941ff192970cad99e186badf96a827baf884396d85305789772b0c768a937a
MD5 9f9b480a7994698ec5cdd861b02aca40
BLAKE2b-256 5d7d6ad254d1ac2b6d24fd8c16e61573be9681865589dc0419b5cb813f777409

See more details on using hashes here.

File details

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

File metadata

  • Download URL: k_flow-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 10.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0a4e6e839ad897313efb8eb5bb4d6f7a78828cfaf6d4b213cb02736a255e2619
MD5 7a2634e706cc69d8acd3789dd8335475
BLAKE2b-256 b083a0f29487c1124d54d2695dd441161be9b337343c79d0a58f0e80abff9cae

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