agk 0.1.0__tar.gz

agk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agk-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: agk
+Version: 0.1.0
+Summary: app-gui-kit Python server SDK — Flask server + framework-less Web Components shell for simulation/agent app GUIs (SSE streaming, HITL gates, pluggable viewers)
+Author: ToPo-ToPo-ToPo
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/ToPo-ToPo-ToPo/app-gui-kit
+Keywords: gui,sse,agent,simulation,flask,web-components
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Flask
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask>=3.1
+Dynamic: license-file
+
+# 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).
+
+```python
+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()
+```
+
+```html
+<!-- 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
+
+```sh
+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](https://threejs.org)
+  (MIT, © Three.js Authors); its license banner is retained in the bundle.

agk-0.1.0/README.md

@@ -0,0 +1,56 @@
+# 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).
+
+```python
+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()
+```
+
+```html
+<!-- 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
+
+```sh
+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](https://threejs.org)
+  (MIT, © Three.js Authors); its license banner is retained in the bundle.

agk-0.1.0/agk/__init__.py

@@ -0,0 +1,23 @@
+"""app-gui-kit Python サーバ SDK。
+
+シミュレーションエージェント系アプリの Flask 定型(SSE ストリーミング、
+単一フライト、ライフサイクル watchdog、成果物配信、remote-job キュー、
+アップロード、HITL ゲート、起動処理)を提供する。
+
+使い方::
+
+    from agk import AgkApp
+
+    def runner(req, ctx):
+        ctx.emit.text("hello")
+        ctx.emit.done(summary="finished")
+
+    AgkApp("my-app", runner).run()
+"""
+
+from .core import AgkApp, AgkContext
+from .events import EventSink
+from .gates import GateHub
+
+__all__ = ["AgkApp", "AgkContext", "EventSink", "GateHub", "__version__"]
+__version__ = "0.1.0"

agk-0.1.0/agk/cli.py

@@ -0,0 +1,189 @@
+"""agk CLI — アプリのスキャフォールド生成。
+
+使い方::
+
+    agk new <name> [--lang python|julia]
+                   [--viewer media|cards|field2d|gltf|mesh|webgpu|none]
+                   [--dir .]
+
+`agk/templates/<lang>/` の ``*.tmpl`` を ``str.format`` 置換
+({name} / {viewer_script} / {viewer_example} / {viewer_note})で展開する。
+テンプレート内の literal な波括弧は ``{{`` / ``}}`` でエスケープする。
+"""
+
+from __future__ import annotations
+
+import argparse
+import re
+import sys
+from pathlib import Path
+
+__all__ = ["main"]
+
+TEMPLATES_DIR = Path(__file__).resolve().parent / "templates"
+LANGS = ("python", "julia")
+VIEWERS = ("media", "cards", "field2d", "gltf", "mesh", "webgpu", "none")
+
+NAME_RE = re.compile(r"^[A-Za-z0-9][A-Za-z0-9._-]*$")
+
+# viewer 名 → dist 配布モジュール(/agk/ 配下)。none はインポートなし。
+_VIEWER_MODULES = {v: f"agk-viewer-{v}.js" for v in VIEWERS if v != "none"}
+
+# viewer 名 → app.py に埋めるコメント付き成果物例(protocol.md §5)。
+_PY_EXAMPLES = {
+    "media": '''\
+    # --- 成果物(media ビューア: image / video)---------------------------
+    # png = ctx.workspace / "plot.png"
+    # png.write_bytes(...)  # 画像を生成
+    # ctx.emit.artifact("image", url="/artifact/plot.png", mime="image/png")
+''',
+    "cards": '''\
+    # --- 成果物(cards ビューア)------------------------------------------
+    # import json
+    # cards = [{"title": "result A", "snippet": "...", "badges": ["ok"]}]
+    # path = ctx.workspace / "cards.json"
+    # path.write_text(json.dumps(cards, ensure_ascii=False), encoding="utf-8")
+    # ctx.emit.artifact("cards", url="/artifact/cards.json",
+    #                   mime="application/json", replace=False)
+''',
+    "field2d": '''\
+    # --- 成果物(field2d ビューア: 2D スカラー場グリッド)------------------
+    # import json
+    # nx, ny = 32, 32
+    # data = {"nx": nx, "ny": ny,
+    #         "fields": [{"name": "u", "data": [0.0] * (nx * ny)}]}
+    # path = ctx.workspace / "field.json"
+    # path.write_text(json.dumps(data), encoding="utf-8")
+    # ctx.emit.artifact("field2d", url="/artifact/field.json",
+    #                   mime="application/json")
+''',
+    "gltf": '''\
+    # --- 成果物(gltf ビューア: GLB / glTF)--------------------------------
+    # glb = ctx.workspace / "model.glb"
+    # glb.write_bytes(...)  # GLB を生成
+    # ctx.emit.artifact("gltf", url="/artifact/model.glb",
+    #                   mime="model/gltf-binary", meta={"up": "z"})
+''',
+    "mesh": '''\
+    # --- 成果物(mesh ビューア: FEM メッシュ+結果)-------------------------
+    # path = ctx.workspace / "mesh.json"
+    # path.write_text(...)  # メッシュ+フィールドを書き出す
+    # ctx.emit.artifact("mesh", url="/artifact/mesh.json",
+    #                   meta={"fields": [{"name": "stress", "unit": "MPa"}]})
+''',
+    "webgpu": '''\
+    # --- 成果物(webgpu ビューア: 大規模粒子/格子の GPU 描画)---------------
+    # 標準 kind(field2d 等)かアプリ固有 kind("x-<app>.<name>")を送る。
+    # ctx.emit.artifact("field2d", url="/artifact/field.json",
+    #                   mime="application/json")
+''',
+    "none": '''\
+    # --- 成果物(組み込みビューア: markdown / image / video)---------------
+    # md = ctx.workspace / "result.md"
+    # md.write_text("## 結果\\n", encoding="utf-8")
+    # ctx.emit.artifact("markdown", url="/artifact/result.md",
+    #                   mime="text/markdown")
+''',
+}
+
+# viewer 名 → app.jl に埋めるコメント例。
+_JL_EXAMPLES = {
+    "none": '''\
+    #   path = joinpath(ctx.workspace, "result.md")
+    #   write(path, "## 結果\\n")
+    #   emit(ctx, "artifact"; kind="markdown", url="/artifact/result.md",
+    #        mime="text/markdown")''',
+}
+
+
+def _jl_example(viewer: str) -> str:
+    if viewer in _JL_EXAMPLES:
+        return _JL_EXAMPLES[viewer]
+    return (
+        f'    #   emit(ctx, "artifact"; kind="{viewer if viewer != "media" else "image"}",\n'
+        f'    #        url="/artifact/result", mime="application/octet-stream")'
+    )
+
+
+def _viewer_script(viewer: str) -> str:
+    """index.html に挿す viewer モジュールの <script> 行(none は空)。"""
+    module = _VIEWER_MODULES.get(viewer)
+    if module is None:
+        return ""
+    return f'<script type="module" src="/agk/{module}"></script>\n'
+
+
+def _viewer_note(viewer: str) -> str:
+    """README に挿す viewer の補足(none は空)。"""
+    module = _VIEWER_MODULES.get(viewer)
+    if module is None:
+        return ""
+    return (
+        f"\n## ビューア\n\n"
+        f"`{viewer}` ビューア(`/agk/{module}`)を index.html でインポート済み。\n"
+        f"対応する artifact イベントの契約は `spec/protocol.md` §5 を参照。\n"
+    )
+
+
+def cmd_new(args: argparse.Namespace) -> int:
+    if not NAME_RE.match(args.name):
+        print(f"agk new: 不正なアプリ名です: {args.name!r} "
+              "(英数字で始まり、英数字と . _ - のみ使用可)", file=sys.stderr)
+        return 2
+
+    src_dir = TEMPLATES_DIR / args.lang
+    if not src_dir.is_dir():
+        print(f"agk new: テンプレートが見つかりません: {src_dir}", file=sys.stderr)
+        return 2
+
+    target = Path(args.dir).expanduser().resolve() / args.name
+    if target.exists() and any(target.iterdir()):
+        print(f"agk new: 出力先が空ではありません: {target}", file=sys.stderr)
+        return 2
+
+    subs = {
+        "name": args.name,
+        "viewer_kind": args.viewer,
+        "viewer_script": _viewer_script(args.viewer),
+        "viewer_note": _viewer_note(args.viewer),
+        "viewer_example": (_PY_EXAMPLES[args.viewer] if args.lang == "python"
+                           else _jl_example(args.viewer)),
+    }
+
+    target.mkdir(parents=True, exist_ok=True)
+    created: list[str] = []
+    for tmpl in sorted(src_dir.glob("*.tmpl")):
+        out = target / tmpl.name.removesuffix(".tmpl")
+        out.write_text(tmpl.read_text(encoding="utf-8").format(**subs),
+                       encoding="utf-8")
+        created.append(out.name)
+
+    print(f"created: {target}")
+    for name in created:
+        print(f"  {name}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="agk", description="app-gui-kit CLI(アプリのスキャフォールド生成)")
+    sub = parser.add_subparsers(dest="command", required=True)
+
+    new = sub.add_parser("new", help="新規アプリの雛形を生成する")
+    new.add_argument("name", help="アプリ名(生成するディレクトリ名)")
+    new.add_argument("--lang", choices=LANGS, default="python",
+                     help="サーバ言語(既定: python)")
+    new.add_argument("--viewer", choices=VIEWERS, default="none",
+                     help="使用する標準ビューア(既定: none)")
+    new.add_argument("--dir", default=".",
+                     help="生成先の親ディレクトリ(既定: カレント)")
+
+    args = parser.parse_args(argv)
+    if args.command == "new":
+        return cmd_new(args)
+    parser.error(f"unknown command: {args.command}")
+    return 2  # unreachable
+
+
+if __name__ == "__main__":
+    sys.exit(main())