Metadata-Version: 2.4
Name: abstractgateway
Version: 0.2.14
Summary: AbstractGateway: deployable Run Gateway host for AbstractRuntime (commands + ledger).
Project-URL: GitHub, https://github.com/lpalbou/abstractgateway
Project-URL: Documentation, https://www.lpalbou.info/AbstractGateway/
Project-URL: Changelog, https://github.com/lpalbou/abstractgateway/blob/main/CHANGELOG.md
Author: Laurent-Philippe Albou
License: MIT
Requires-Python: >=3.10
Requires-Dist: abstractagent>=0.3.7
Requires-Dist: abstractcore[audio,remote,tokens,tools,vision,voice]>=2.13.15
Requires-Dist: abstractflow>=0.3.11
Requires-Dist: abstractmemory[lancedb]>=0.2.6
Requires-Dist: abstractruntime[multimodal]>=0.4.14
Requires-Dist: abstractvision>=0.3.6
Requires-Dist: abstractvoice>=0.10.3
Requires-Dist: anyio<5.0.0,>=4.12.1
Requires-Dist: fastapi<1.0.0,>=0.136.0
Requires-Dist: httpx<1.0.0,>=0.28.1
Requires-Dist: numpy<3.0.0,>=1.20.0
Requires-Dist: openai<2.0.0,>=1.109.1
Requires-Dist: pandas<3.0.0,>=1.0.0
Requires-Dist: pillow<13.0.0,>=10.0.0
Requires-Dist: pymupdf-layout<2.0.0,>=1.26.6
Requires-Dist: pymupdf4llm<1.0.0,>=0.0.20
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: python-pptx<2.0.0,>=1.0.2
Requires-Dist: requests<3.0.0,>=2.32.5
Requires-Dist: sentence-transformers<6.0.0,>=5.1.0
Requires-Dist: setuptools<82.0.0,>=80.10.2
Requires-Dist: unstructured[docx,odt,pptx,rtf,xlsx]<0.19.0,>=0.18.32
Requires-Dist: urllib3<3.0.0,>=2.5.0
Requires-Dist: uvicorn[standard]<1.0.0,>=0.38.0
Provides-Extra: all
Provides-Extra: all-apple
Requires-Dist: abstractagent[all-apple]>=0.3.7; extra == 'all-apple'
Requires-Dist: abstractcore[all-apple]>=2.13.15; extra == 'all-apple'
Requires-Dist: abstractmemory[all-apple]>=0.2.6; extra == 'all-apple'
Requires-Dist: abstractmusic[all-apple]>=0.1.2; extra == 'all-apple'
Requires-Dist: abstractruntime[all-apple,multimodal]>=0.4.14; extra == 'all-apple'
Requires-Dist: abstractvision[all-apple]>=0.3.6; extra == 'all-apple'
Requires-Dist: abstractvoice[all-apple]>=0.10.3; extra == 'all-apple'
Provides-Extra: all-gpu
Requires-Dist: abstractagent[all-gpu]>=0.3.7; extra == 'all-gpu'
Requires-Dist: abstractcore[all-gpu]>=2.13.15; extra == 'all-gpu'
Requires-Dist: abstractmemory[all-gpu]>=0.2.6; extra == 'all-gpu'
Requires-Dist: abstractmusic[all-gpu]>=0.1.2; extra == 'all-gpu'
Requires-Dist: abstractruntime[all-gpu,multimodal]>=0.4.14; extra == 'all-gpu'
Requires-Dist: abstractvision[all-gpu]>=0.3.6; extra == 'all-gpu'
Requires-Dist: abstractvoice[all-gpu]>=0.10.3; extra == 'all-gpu'
Provides-Extra: apple
Requires-Dist: abstractagent[all-apple]>=0.3.7; extra == 'apple'
Requires-Dist: abstractcore[all-apple]>=2.13.15; extra == 'apple'
Requires-Dist: abstractmemory[all-apple]>=0.2.6; extra == 'apple'
Requires-Dist: abstractmusic[all-apple]>=0.1.2; extra == 'apple'
Requires-Dist: abstractruntime[all-apple,multimodal]>=0.4.14; extra == 'apple'
Requires-Dist: abstractvision[all-apple]>=0.3.6; extra == 'apple'
Requires-Dist: abstractvoice[all-apple]>=0.10.3; extra == 'apple'
Provides-Extra: dev
Requires-Dist: httpx>=0.27.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
Provides-Extra: gpu
Requires-Dist: abstractagent[all-gpu]>=0.3.7; extra == 'gpu'
Requires-Dist: abstractcore[all-gpu]>=2.13.15; extra == 'gpu'
Requires-Dist: abstractmemory[all-gpu]>=0.2.6; extra == 'gpu'
Requires-Dist: abstractmusic[all-gpu]>=0.1.2; extra == 'gpu'
Requires-Dist: abstractruntime[all-gpu,multimodal]>=0.4.14; extra == 'gpu'
Requires-Dist: abstractvision[all-gpu]>=0.3.6; extra == 'gpu'
Requires-Dist: abstractvoice[all-gpu]>=0.10.3; extra == 'gpu'
Provides-Extra: http
Provides-Extra: memory
Provides-Extra: multimodal
Provides-Extra: server
Provides-Extra: server-nvidia
Requires-Dist: abstractagent[all-gpu]>=0.3.7; extra == 'server-nvidia'
Requires-Dist: abstractcore[all-gpu]>=2.13.15; extra == 'server-nvidia'
Requires-Dist: abstractmemory[all-gpu]>=0.2.6; extra == 'server-nvidia'
Requires-Dist: abstractmusic[all-gpu]>=0.1.2; extra == 'server-nvidia'
Requires-Dist: abstractruntime[all-gpu,multimodal]>=0.4.14; extra == 'server-nvidia'
Requires-Dist: abstractvision[all-gpu]>=0.3.6; extra == 'server-nvidia'
Requires-Dist: abstractvoice[all-gpu]>=0.10.3; extra == 'server-nvidia'
Provides-Extra: telegram
Provides-Extra: vision
Provides-Extra: visualflow
Provides-Extra: voice
Description-Content-Type: text/markdown

# AbstractGateway

AbstractGateway is a **deployable Run Gateway host** for AbstractRuntime runs:
- start durable runs
- accept a durable command inbox
- replay/stream a durable ledger (replay-first)
- enforce a security baseline (token + origin allowlist + limits)

This decouples the gateway service from any specific UI (AbstractFlow, AbstractCode, web/PWA thin clients).

Start here: [docs/getting-started.md](docs/getting-started.md)

## AbstractFramework ecosystem

AbstractGateway is part of the **AbstractFramework** ecosystem:

- **AbstractRuntime** (required): durable run model + workflow registry + stores (`pyproject.toml`, `src/abstractgateway/runner.py`)
- **AbstractCore / AbstractVoice / AbstractVision / AbstractMemory** (required by the default server install): LLM/tool execution, provider-level prompt-cache controls, workflow-backed/direct generated image/voice/audio capabilities, and KG memory used by Gateway bundles (`src/abstractgateway/hosts/bundle_host.py`)
- Higher-level UIs (optional): AbstractFlow (authoring/bundling), AbstractCode / AbstractObserver / thin clients (rendering + operations)

Related repos:
- AbstractFramework: https://github.com/lpalbou/AbstractFramework
- AbstractCore: https://github.com/lpalbou/abstractcore
- AbstractRuntime: https://github.com/lpalbou/abstractruntime

## Quickstart (HTTP server, bundle mode)

```bash
pip install abstractgateway

export ABSTRACTGATEWAY_FLOWS_DIR="/path/to/bundles"   # *.flow dir (or a single .flow file)
export ABSTRACTGATEWAY_DATA_DIR="$PWD/runtime/gateway"

# Required by default: the server refuses to start without a token.
export ABSTRACTGATEWAY_AUTH_TOKEN="$(python -c 'import secrets; print(secrets.token_urlsafe(32))')"
# Browser-origin allowlist (glob patterns). Default allows localhost; customize when exposing remotely.
export ABSTRACTGATEWAY_ALLOWED_ORIGINS="http://localhost:*,http://127.0.0.1:*"

abstractgateway serve --host 127.0.0.1 --port 8080
```

OpenAPI docs (Swagger UI): `http://127.0.0.1:8080/docs`

Smoke checks:

```bash
curl -sS "http://127.0.0.1:8080/api/health"

curl -sS -H "Authorization: Bearer $ABSTRACTGATEWAY_AUTH_TOKEN" \
  "http://127.0.0.1:8080/api/gateway/bundles"
```

## Docker server

Release images are published to GHCR. The default image is the light,
portable server image:

```bash
docker pull ghcr.io/lpalbou/abstractgateway-server:0.2.8
```

NVIDIA hosts can try the experimental full GPU image when local
vLLM/HuggingFace/Diffusers engines are wanted. This image is published
best-effort until it has a real CUDA build and smoke gate:

```bash
docker pull ghcr.io/lpalbou/abstractgateway-server-nvidia:0.2.8
```

The image installs the base `abstractgateway` package: HTTP server,
`AbstractRuntime[multimodal]`, AbstractCore remote/commercial provider support,
OpenAI-compatible text providers, workflow-backed and direct image generation
through Runtime/Core/AbstractVision, direct Gateway voice/audio endpoints
through AbstractVoice, provider/session prompt-cache helpers, media/tool
helpers, token counting, compression, AbstractMemory/LanceDB KG support,
AbstractAgent, and AbstractFlow compatibility.

```bash
export ABSTRACTGATEWAY_AUTH_TOKEN="$(python -c 'import secrets; print(secrets.token_urlsafe(32))')"

docker run --rm --name abstractgateway-server \
  -p 127.0.0.1:8080:8080 \
  -e ABSTRACTGATEWAY_AUTH_TOKEN="$ABSTRACTGATEWAY_AUTH_TOKEN" \
  -e ABSTRACTGATEWAY_PROVIDER="openai-compatible" \
  -e ABSTRACTGATEWAY_MODEL="your-model" \
  -e OPENAI_COMPATIBLE_BASE_URL="http://host.docker.internal:1234/v1" \
  -v "$PWD/runtime/gateway:/data/gateway" \
  -v "$PWD/flows/bundles:/data/flows:ro" \
  ghcr.io/lpalbou/abstractgateway-server:0.2.8
```

On Apple Silicon, keep Metal/MLX inference native on macOS and run the
lightweight Gateway container as the transport/control plane. Point
`OPENAI_COMPATIBLE_BASE_URL` at a host-native OpenAI-compatible endpoint such
as Docker Model Runner (`http://model-runner.docker.internal/engines/v1`), LM
Studio (`http://host.docker.internal:1234/v1`), Ollama
(`http://host.docker.internal:11434/v1`), or `mlx_lm.server` on a host port.
For native non-Docker installs with local engines, use
`pip install "abstractgateway[apple]"` on Apple Silicon, and
`pip install "abstractgateway[gpu]"` on GPU workstations or NVIDIA Docker builds.
For a minimal Apple-local Gateway + Flow setup, see
[docs/apple-local-gateway-flow.md](docs/apple-local-gateway-flow.md).

Compose and deployment details: [docs/deployment.md](docs/deployment.md).

## 0.2.8 capability scope

Direct Gateway APIs in this release:
- `GET /api/gateway/runs/{run_id}/input_data`
- `GET /api/gateway/runs/{run_id}/history_bundle`
- `POST /api/gateway/runs/{run_id}/voice/tts`
- `POST /api/gateway/runs/{run_id}/audio/transcribe`
- `POST /api/gateway/runs/{run_id}/images/generate`
- `GET /api/gateway/voice/voices`
- `GET /api/gateway/audio/speech/models`
- `GET /api/gateway/audio/transcriptions/models`
- `GET /api/gateway/vision/provider_models`
- `GET /api/gateway/vision/models`
- `/api/gateway/prompt_cache/*` provider/model operator controls
- `/api/gateway/sessions/{session_id}/prompt_cache/*` session lifecycle controls
- `/api/gateway/kg/query` with configurable `lancedb` or in-memory AbstractMemory stores, plus `sqlite` when the installed AbstractMemory build exposes `SQLiteTripleStore`
- `/api/gateway/discovery/capabilities` package, plugin, and thin-client contract discovery

Workflow/Core-backed capabilities:
- Generated images are available to Runtime/Core workflows through
  AbstractVision when installed and configured, and the direct Gateway image
  route uses the same Runtime/Core image-generation contract.
- Prompt-cache support depends on the active provider/model. Session lifecycle
  routes provide Gateway-owned naming and orchestration, not a provider-
  independent local KV cache.

## Client contract (replay-first)

- Clients **start runs**: `POST /api/gateway/runs/start`
- Clients can **schedule runs** (bundle mode): `POST /api/gateway/runs/schedule`
- Clients **act** by submitting durable commands: `POST /api/gateway/commands`
  - supported types: `pause|resume|cancel|emit_event|update_schedule|compact_memory`
- Clients **render** by replaying/streaming the durable ledger:
  - replay: `GET /api/gateway/runs/{run_id}/ledger?after=...`
  - stream (SSE): `GET /api/gateway/runs/{run_id}/ledger/stream?after=...`

See [docs/api.md](docs/api.md) for curl examples and the live OpenAPI spec (`/openapi.json`).

## Install

### Base remote-light server

Requires Python `>=3.10` (see `pyproject.toml`).

The base install is the remote-light HTTP/SSE server: Gateway, Runtime,
Agent, Core remote provider/tool/media support, Flow compatibility, Vision,
Voice, and LanceDB-backed Memory.

```bash
pip install abstractgateway
```

### Optional extras

- `abstractgateway[apple]`: full native macOS Python profile with Apple-local engines and all non-NVIDIA framework capabilities
- `abstractgateway[gpu]`: full local GPU profile with vLLM/HuggingFace, local Diffusers image generation, local voice engines, music, and KG memory; this is also the NVIDIA Docker install profile
- `abstractgateway[server]`, `[http]`, `[multimodal]`, `[memory]`, `[voice]`, `[vision]`, and `[all]`: compatibility aliases; the base package already includes the remote-light server stack
- `abstractgateway[server-nvidia]`: compatibility alias for the GPU profile used by older NVIDIA Docker commands
- `abstractgateway[telegram]` and `[visualflow]`: compatibility aliases; Telegram bridge and VisualFlow publishing use base install dependencies
- `abstractgateway[docs]`: MkDocs site tooling
- `abstractgateway[dev]`: local test/dev deps

KG memory nodes use Gateway's memory resolver. The default durable/vector
backend is LanceDB; `memory` is process-local dev/test storage, and `sqlite` is
structured-only when the installed AbstractMemory build exposes
`SQLiteTripleStore`.

Gateway has a first-class config helper:

```bash
abstractgateway-config status
abstractgateway config init --env-file .env
```

For details on `ABSTRACTGATEWAY_PROVIDER`/`MODEL`, store backends, and workflow sources, see [docs/configuration.md](docs/configuration.md).

## 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
```

See [docs/getting-started.md](docs/getting-started.md) for running, split API/runner, and file→SQLite migration.

## Docs

Published docs site: https://www.lpalbou.info/AbstractGateway/

### Project docs

- Changelog: [CHANGELOG.md](CHANGELOG.md) (compat: `CHANGELOD.md`)
- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
- Security policy (vulnerability reporting): [SECURITY.md](SECURITY.md)
- Acknowledgments: [ACKNOWLEDGMENTS.md](ACKNOWLEDGMENTS.md) (compat: `ACKNOWLEDMENTS.md`)

### Package docs

- Docs index: [docs/README.md](docs/README.md)
- Getting started: [docs/getting-started.md](docs/getting-started.md)
- FAQ: [docs/faq.md](docs/faq.md)
- Architecture: [docs/architecture.md](docs/architecture.md)
- Configuration: [docs/configuration.md](docs/configuration.md)
- Deployment: [docs/deployment.md](docs/deployment.md)
- API overview: [docs/api.md](docs/api.md)
- Security: [docs/security.md](docs/security.md)
- Operator tooling (optional): [docs/maintenance.md](docs/maintenance.md)
