abstractgateway 0.1.0__py3-none-any.whl

abstractgateway-0.1.0.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: abstractgateway
+Version: 0.1.0
+Summary: AbstractGateway: deployable Run Gateway host for AbstractRuntime (commands + ledger).
+Project-URL: GitHub, https://github.com/lpalbou/abstractgateway
+Author: Laurent-Philippe Albou
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: abstractruntime>=0.4.0
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: uvicorn[standard]>=0.23.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Provides-Extra: visualflow
+Requires-Dist: abstractflow>=0.3.0; extra == 'visualflow'
+Description-Content-Type: text/markdown
+
+# AbstractGateway
+
+AbstractGateway is the **deployable Run Gateway host** for AbstractRuntime runs:
+- durable command inbox
+- ledger replay/stream
+- security baseline (token + origin + limits)
+
+This decouples the gateway service from any specific UI (AbstractFlow, AbstractCode, web/PWA thin clients).
+
+## What it does (contract)
+- Clients **act** by submitting durable commands: `start`, `resume`, `pause`, `cancel`, `emit_event`
+- Clients **render** by replaying/streaming the durable ledger (cursor-based, replay-first)
+
+Endpoints:
+- `POST /api/gateway/runs/start`
+- `GET /api/gateway/runs/{run_id}`
+- `GET /api/gateway/runs/{run_id}/ledger`
+- `GET /api/gateway/runs/{run_id}/ledger/stream` (SSE)
+- `POST /api/gateway/commands`
+
+## Install
+
+### Default (bundle mode)
+
+```bash
+pip install abstractgateway
+```
+
+Bundle mode executes **WorkflowBundles** (`.flow`) via **WorkflowArtifacts** without importing `abstractflow`.
+
+### Optional (compatibility): VisualFlow JSON
+
+```bash
+pip install "abstractgateway[visualflow]"
+```
+
+This mode depends on the **AbstractFlow compiler library** (`abstractflow`) to interpret VisualFlow JSON (it does **not** require the AbstractFlow web UI/app).
+
+## Run
+
+```bash
+export ABSTRACTGATEWAY_DATA_DIR="./runtime"
+export ABSTRACTGATEWAY_FLOWS_DIR="/path/to/bundles-or-flow"
+
+# Security (recommended)
+export ABSTRACTGATEWAY_AUTH_TOKEN="your-token"
+export ABSTRACTGATEWAY_ALLOWED_ORIGINS="*"
+
+abstractgateway serve --host 127.0.0.1 --port 8080
+```
+
+Notes:
+- `ABSTRACTGATEWAY_WORKFLOW_SOURCE` defaults to `bundle`. Valid values:
+  - `bundle` (default): `ABSTRACTGATEWAY_FLOWS_DIR` points to a directory containing `*.flow` bundles (or a single `.flow` file)
+  - `visualflow` (compat): `ABSTRACTGATEWAY_FLOWS_DIR` points to a directory containing `*.json` VisualFlow files
+- For production, run behind HTTPS (reverse proxy) and set exact allowed origins.
+
+## Creating a `.flow` bundle (authoring)
+
+Use AbstractFlow to pack a bundle:
+
+```bash
+abstractflow bundle pack /path/to/root.json --out /path/to/bundles/my.flow --flows-dir /path/to/flows
+```
+
+## Starting a run (bundle mode)
+
+The stable way is to pass `bundle_id` + `flow_id`:
+
+```bash
+curl -sS -X POST "http://localhost:8080/api/gateway/runs/start" \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer your-token" \
+  -d '{"bundle_id":"my-bundle","flow_id":"ac-echo","input_data":{}}'
+```
+
+For backwards-compatible clients, you can also pass a namespaced id as `flow_id` (`"my-bundle:ac-echo"`).
+
+## Docs
+- Architecture: `docs/architecture.md` (framework) and `abstractgateway/docs/architecture.md` (this package)
+- Deployment: `docs/guide/deployment.md`
+
+

abstractgateway-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+abstractgateway/__init__.py,sha256=JiTSUsov4YukN0mAmjzaQoSI5JDmwSrhf6KP0qVl2fY,281
+abstractgateway/app.py,sha256=m6xQbTNnScc1XHtvnBCJiFCHt1AOun5v-7mrypSV5es,1541
+abstractgateway/cli.py,sha256=q8uVDOqMyTxaCzsFvtFFHVAn0P4JtDabI0kCDuEDFvI,941
+abstractgateway/config.py,sha256=V7HthrkWjR1XQaanGBW2npHiF2_lCZ7IqonisxAguw8,3150
+abstractgateway/runner.py,sha256=3itMuGQvR3iJ5ITbxbaa2vhbYjGleGqKUNaq7AGqfFE,17080
+abstractgateway/service.py,sha256=HfpNgmtXM9Q8LQnl0Ag1G99g79MqFbOPzmv4ondqJWE,4992
+abstractgateway/stores.py,sha256=7Wlq5Zvmy5LWOGT5GBXfK9Se9MZu7IM6XUoqOXTpF-Q,1010
+abstractgateway/hosts/__init__.py,sha256=RiIODYtCPUYeVPDKmVhqKLVwxw3D_NWdw4gnetVKdhA,170
+abstractgateway/hosts/bundle_host.py,sha256=Ji3rR_DlhmJ2tqpQfCNpqKIVzjfNtnFZj3BCaUbLWwU,25380
+abstractgateway/hosts/visualflow_host.py,sha256=xq90TYV1Ac4cSlXXwjvJZ4W1G2f6IzglTiWKntnq6Co,7554
+abstractgateway/routes/__init__.py,sha256=qkxhZHLypa0-NlczRKA3wUmHsRXIx93HroBRc6g7BAo,78
+abstractgateway/routes/gateway.py,sha256=ANTEuS6n-AaMBuBPFlZJ_kkpfbMN4uzyizso2P5p784,14747
+abstractgateway/security/__init__.py,sha256=2pKIec_kuQ53_UAl0uij3u_1MInQOVDY_MF7ERr4Rgw,211
+abstractgateway/security/gateway_security.py,sha256=1uhJ99i4Ifh24waqhNDO7euWnUZHmVOBMLIQxPoL2OE,18270
+abstractgateway-0.1.0.dist-info/METADATA,sha256=lwOX7FB1yFLCfS1xMrO1RljdtuVA3UtH1Siu7SjQfN4,3293
+abstractgateway-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+abstractgateway-0.1.0.dist-info/entry_points.txt,sha256=eDg0b1pu1ZLoFC8ZId_AlHn5rgaakmshL4vvI_FeAB4,61
+abstractgateway-0.1.0.dist-info/RECORD,,

abstractgateway-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

abstractgateway-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+abstractgateway = abstractgateway.cli:main