Skip to main content

app-gui-kit Python server SDK — Flask server + framework-less Web Components shell for simulation/agent app GUIs (SSE streaming, HITL gates, pluggable viewers)

Project description

agk — app-gui-kit Python server SDK

A small framework for building local, single-user GUIs for simulation / agent applications. One AgkApp gives you a Flask server implementing the app-gui-kit protocol, and the bundled frontend kit (framework-less Web Components) gives you a ready-made shell — composer, streaming task log, and pluggable result viewers (glTF / STL / FEM mesh / 2D fields / WebGPU / media / cards / markdown / deck).

from agk import AgkApp

def runner(req, ctx):
    ctx.emit.task("t1", "running", title="Analyze")
    ctx.emit.text("working…")
    if req.get("options", {}).get("step"):
        ctx.gate("Proceed?")                     # human-in-the-loop gate
    ctx.emit.artifact("gltf", url="/artifact/result.glb")
    ctx.emit.task("t1", "done")
    ctx.emit.done(summary="finished")

AgkApp("My Agent App", runner, capabilities=("step",)).run()
<!-- index.html — zero build step -->
<link rel="stylesheet" href="/agk/agk.css">
<script type="module" src="/agk/agk.js"></script>
<script type="module" src="/agk/agk-viewer-gltf.js"></script>
<agk-shell app="My Agent App"></agk-shell>

What AgkApp provides

  • POST /stream — SSE event streaming (single-flight), plus a polling transport for clients that cannot use SSE
  • POST /cancel / POST /reset / POST /intervene (HITL gates)
  • GET /artifact/<path> (traversal-safe) and POST /upload
  • GET /agk/<path> — serves the bundled frontend kit
  • /alive + /bye window-lifecycle watchdog (auto-exit when the tab closes)
  • /agent/* remote-job queue for headless (LLM) driving
  • /voice_status + /transcribe with a pluggable transcriber

Scaffolding

agk new my-sim-app --viewer field2d          # Python app
agk new my-jl-app --lang julia --viewer gltf # Julia app (AppGuiKit.jl)

Notes

  • The protocol, endpoints, design tokens and viewer interface are specified in the app-gui-kit repository (spec/).
  • The bundled frontend (agk/static/) includes three.js (MIT, © Three.js Authors); its license banner is retained in the bundle.

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

agk-0.4.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

agk-0.4.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file agk-0.4.0.tar.gz.

File metadata

  • Download URL: agk-0.4.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for agk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 36913a080db263a421b83eab4f2f7c3c48f28544b8b5718269eca98e02ae007d
MD5 aa8614f4dc1a50b92abf474594843246
BLAKE2b-256 edbe961c38b133ad01be92c4741cf94b689c5b5e289b4d3bb35f8323895e8317

See more details on using hashes here.

File details

Details for the file agk-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: agk-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for agk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 262b8ed6a82a8e04f696fbfb06b30c05cc50e1e2d9565f8a83df6d6e00ae3439
MD5 ffa991548147dce963c9296416b56dcb
BLAKE2b-256 19f1ff2142f911e117f9ffdb1cd2b0c0695b9235a8e81333b91b0ae3c37b0c74

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