Metadata-Version: 2.4
Name: forkflux-api
Version: 0.1.0
Summary: Core API server and coordination bus for cross-device AI agent task handoff.
Project-URL: Homepage, https://github.com/forkflux/forkflux
Project-URL: Repository, https://github.com/forkflux/forkflux
Project-URL: Issues, https://github.com/forkflux/forkflux/issues
Keywords: agents,ai,coordination,developer-tools,fastapi,handoff,llm,multi-agent,task-delegation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.14
Requires-Dist: aiosqlite==0.22.1
Requires-Dist: alembic-postgresql-enum==1.10.0
Requires-Dist: alembic==1.18.4
Requires-Dist: asyncpg==0.31.0
Requires-Dist: fastapi==0.137.2
Requires-Dist: gunicorn==26.0.0
Requires-Dist: pydantic-settings==2.14.1
Requires-Dist: pydantic==2.13.4
Requires-Dist: sqlalchemy==2.0.51
Requires-Dist: structlog==26.1.0
Requires-Dist: typer==0.26.7
Requires-Dist: uvicorn==0.49.0
Description-Content-Type: text/markdown

# ForkFlux API

> Core API server and coordination bus for cross-device AI agent task handoff.

ForkFlux API is the stateful coordination layer behind ForkFlux. It gives isolated AI agents a shared, machine-readable job pool for publishing work, atomically claiming tasks, transferring context and artifacts, and closing jobs with explicit lifecycle states.

Use this package when you need the ForkFlux coordination bus service itself: a FastAPI application backed by PostgreSQL or SQLite, plus a small CLI for registering target roles and agent API tokens.

## What it provides

- **Shared handoff queue** for agent-to-agent job delegation.
- **Atomic claims** so only one agent can own a published job.
- **Structured context transfer** through job constraints, payloads, and artifacts.
- **Lifecycle control** for `published` → `in_progress` → `completed` / `failed` / `cancelled`.
- **Agent identity and role registry** for role-aware routing.

## Package

```bash
pip install forkflux-api
```

The installed CLI entry point is:

```bash
forkflux --help
```

## Runtime requirements

- Python 3.14+

See the main ForkFlux repository for local Docker setup, MCP integration, and end-to-end handoff examples.
