Skip to main content

Python-first agent harness framework with Markdown skills, sessions, sandboxes, and pluggable backends.

Project description

PyFlue

CI Docs Landing Page PyPI Python License

PyFlue is the agent harness framework for Python. You build persistent agents and finite workflows, with Markdown skills, stateful sessions, sandboxed filesystem and shell access, typed Pydantic outputs, streaming events, OpenTelemetry tracing, and deployment-ready project structure.

PyFlue adapts the agent harness model for Python teams. The harness that drives it is pluggable: Pydantic AI by default (typed, model agnostic, no LangChain), or DeepAgents for LangChain users, with the registry open for more backends.

Warning: Active Development

PyFlue is under active development. The API may change. Pin your dependencies and review changelogs before updating.

Use it to build coding agents, issue triage agents, data analysis agents, support agents, and workflow agents that need controlled access to files, commands, tools, and structured outputs.

Documentation: https://superagenticai.github.io/pyflue/

Landing page: https://super-agentic.ai/pyflue

Install

With uv:

uv add pyflue

With pip:

pip install pyflue

Optional extras:

uv add "pyflue[monty]"
uv add "pyflue[sandboxes]"
pip install "pyflue[monty]"
pip install "pyflue[sandboxes]"

Quick Start

pyflue init my-agent
cd my-agent
pyflue run --prompt "Review this project"

Run a local server/client smoke demo without a model key:

uv run python examples/server_client/run_smoke.py

Agents and Workflows

PyFlue has two boundaries for model driven work. A persistent agent keeps sessions over time; a finite workflow runs one bounded operation and returns a result.

# A persistent agent in src/agents/assistant.py
from pyflue import create_agent

default = create_agent(lambda ctx: {"model": "openai:gpt-5.5"})
# A finite workflow in src/workflows/summarize.py
from pyflue import FlueContext, create_agent

agent = create_agent(lambda ctx: {"model": "openai:gpt-5.5"})


async def run(ctx: FlueContext) -> dict:
    harness = await ctx.init(agent)
    session = await harness.session()
    response = await session.prompt(ctx.payload["text"])
    return {"summary": response.text}

Agents are served at POST /agents/<name>/<id> and over WebSocket, and accept asynchronous input with dispatch(...). Workflows run with pyflue run <name>, POST /workflows/<name>, or WebSocket. See the Agents vs Workflows guide.

Choose a harness

The harness that runs the model loop is pluggable and does not change your agent or workflow code.

agent = await init(harness="pydanticai")    # default: typed, model agnostic, no LangChain
agent = await init(harness="deepagents")    # optional, for LangChain users: pip install 'pyflue[deepagents]'

Python API

from pydantic import BaseModel
from pyflue import init


class FixResult(BaseModel):
    fix_applied: bool
    summary: str


async def main():
    agent = await init(
        model="openai:gpt-5.5",
        sandbox="virtual",
        allow_write=True,
        allow_shell=True,
        allowed_commands=["git"],
    )
    session = await agent.session("fix-123")
    result = await session.skill(
        "triage",
        args={"issue_number": 123},
        result=FixResult,
    )
    if result.fix_applied:
        await session.shell("git status --short")

What PyFlue Gives You

Capability What it means
Agents Define persistent, addressable agents with create_agent, served over HTTP and WebSocket.
Workflows Define finite operations with run(ctx), run locally, over HTTP, or WebSocket.
Subagents Delegate to declared profiles with task(agent="name").
Dispatch Accept asynchronous agent input with dispatch(...).
Observability Correlated event stream and an OpenTelemetry adapter (pyflue[otel]).
Harness backends DeepAgents (default) or Pydantic AI, pluggable through a registry.
Markdown skills Put reusable workflows in .agents/skills/*.md.
Project instructions Use AGENTS.md for global behavior and context.
Roles Scope behavior with .agents/roles/*.md.
Sessions Resume agent state with stable session IDs.
Tasks Run focused child tasks with isolated history and shared sandbox.
Sandbox Read, write, edit, grep, glob, and shell behind explicit policies.
Secret grants Keep secrets out of prompts and grant them only per call.
Typed outputs Validate results with Pydantic, extract JSON from text, and repair invalid JSON automatically.
Streaming Use session.stream(...), pyflue run --stream, or SSE.
Abort Cancel active prompt, stream, task, and shell operations with session.abort().
Structured commands Expose reusable shell or callable commands with PyFlueCommand.
Python client Call deployed PyFlue servers with PyFlueClient.
Webhooks Expose agents/*.py as /agents/{name}/{agent_id}.
Python code backend Use pyflue[monty] for safe host-side Python snippets.
Remote sandboxes Use Daytona, E2B, Modal, or Runloop with optional extras.
Connector guides Use pyflue add to print agent-readable setup guides for sandbox providers.
Deployment Generate Docker/FastAPI, CI, Railway, Render, Fly.io, Vercel, Netlify, and Cloudflare Containers starter files.

Project Layout

src/ is the canonical layout. Agents and workflows are also discovered from the project root and from .agents or .pyflue.

AGENTS.md
pyflue.toml
.agents/
  roles/
    coder.md
  skills/
    triage.md
src/
  agents/
    assistant.py
  workflows/
    summarize.py

File-Based Agent (legacy)

The original file based handler model is still supported and is treated as workflow like. New projects use create_agent agents and run(ctx) workflows (see Agents and Workflows).

triggers = {"webhook": True}


async def default(context):
    agent = await context.init()
    session = await agent.session(context.agent_id)
    result = await session.prompt(context.payload["prompt"])
    return {"text": result.text}

Run it locally:

pyflue dev --port 2024

Call it:

curl http://127.0.0.1:2024/agents/default/demo \
  -H "Content-Type: application/json" \
  -d '{"payload": {"prompt": "Review this repository"}}'

Streaming

pyflue run --stream --prompt "Review this project"
async for event in session.stream("Review this project"):
    print(event.type, event.data)

Connector Guides

List available guides:

pyflue add

Print a guide for a known sandbox provider:

pyflue add daytona --print

Start from any provider documentation URL:

pyflue add https://e2b.dev/docs --category sandbox --print | codex

Security Model

PyFlue starts with safe defaults:

  • writes are disabled until allow_write=True
  • shell execution is disabled until allow_shell=True
  • compound shell syntax is blocked by default
  • command allowlists are supported with allowed_commands
  • secrets are not injected into prompts
  • secrets are mounted into sandbox calls only when requested with secrets=[...]

Deployment

Generate deployment files:

pyflue build --target docker
pyflue build --target railway
pyflue build --target fly
pyflue build --target vercel
pyflue build --target netlify
pyflue build --target cloudflare

Deploy with a supported provider CLI:

pyflue deploy --target fly

Development

uv sync --extra dev --extra docs
uv run --extra dev ruff check .
uv run --extra dev pytest
uv run --extra docs mkdocs build --strict
uv build

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

pyflue-0.2.0.tar.gz (491.1 kB view details)

Uploaded Source

Built Distribution

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

pyflue-0.2.0-py3-none-any.whl (144.2 kB view details)

Uploaded Python 3

File details

Details for the file pyflue-0.2.0.tar.gz.

File metadata

  • Download URL: pyflue-0.2.0.tar.gz
  • Upload date:
  • Size: 491.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for pyflue-0.2.0.tar.gz
Algorithm Hash digest
SHA256 01b4eba3e82d527911cfda6384958834af6040268f5fab54248577d0436ab0aa
MD5 2d2ad6fab6049c87e61bcb7c6603b644
BLAKE2b-256 6003372a20726745aefa2ce9e012db7d7bbe59687e9812df6c7cea62e7a18a66

See more details on using hashes here.

File details

Details for the file pyflue-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyflue-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 144.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for pyflue-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d47436e8c5622dfa1eae79bb2cf9757c7d9e46e13ccdc3ea5bf152a758c5769f
MD5 492534a40573f4684841c7c0b12ef9f7
BLAKE2b-256 d89ea20d9c71a149e50d96cb4f37d97cade859714974bdfef32aa9fbe8f137c5

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