Skip to content

Latest commit

 

History

History
217 lines (144 loc) · 6 KB

v1.1.md

File metadata and controls

217 lines (144 loc) · 6 KB

Migrating to AgentFlow v1.1

⚠️ PyPI distribution renamed at release time

The SDK PyPI distribution was originally planned as agentflow (per A01 Q2 architecture decision), but the name had been occupied on PyPI since 2023 by an unrelated abandoned project. The SDK is published as agentflow-client instead. Python imports are unchanged:

What changed Old New
pip install command pip install agentflow pip install agentflow-client
Python import statement from agentflow import from agentflow import (same)
Module name in your code agentflow agentflow (same)
importlib.metadata.version version("agentflow") version("agentflow-client")

Upgrading from v1.0.x? This guide takes ≤ 5 minutes.

TL;DR

  • SDK users (you only imported AgentFlowClient): install agentflow-client; Python imports stay the same.
  • Runtime operators (you ran the API from the old unified package): switch to pip install agentflow-runtime.
  • Monorepo contributors: install the root package for runtime code, ./sdk separately for SDK changes.

What changed

Layer v1.0.x v1.1.0
PyPI name (runtime) agentflow agentflow-runtime
PyPI name (SDK) agentflow agentflow-client
Runtime import prefix agentflow.* src.*
SDK import path from agentflow import AgentFlowClient from agentflow import AgentFlowClient (unchanged)
Purpose of agentflow package runtime + SDK bundled Python module name only

The root repository now publishes as agentflow-runtime on PyPI, while the Python SDK publishes as agentflow-client and keeps the clean agentflow import path.

Who is affected

1. SDK-only users — import path NOT affected

You installed agentflow to write agent workflows and only ever imported:

from agentflow import AgentFlowClient, AsyncAgentFlowClient

Use pip install agentflow-client for the SDK distribution. Python imports continue to work exactly as before.

2. Runtime operators — AFFECTED

Install the runtime distribution to run the API locally or in production:

pip install agentflow-runtime
uvicorn src.serving.api.main:app

agentflow no longer contains the runtime. You must install agentflow-runtime instead.

3. Monorepo contributors — AFFECTED

You work inside this repository. Editable installs now split cleanly:

# Runtime (root package)
pip install -e ".[dev,cloud]"

# SDK (separate)
pip install -e "./sdk"

Migration steps

SDK-only users

Update your requirements.txt or lockfile entry to agentflow-client.

Runtime operators

Replace the old unified package with the runtime distribution:

# old unified package: agentflow
# new runtime distribution:
pip install agentflow-runtime

If you previously imported runtime internals, update the import prefix:

# before
from agentflow.serving.api.main import app
from agentflow.processing.local_pipeline import run

# after
from src.serving.api.main import app
from src.processing.local_pipeline import run

Start the API as usual:

uvicorn src.serving.api.main:app

Monorepo contributors

# Install runtime with dev extras
pip install -e ".[dev,cloud]"

# Install SDK separately when you need it
pip install -e "./sdk"

# Optional: integrations package
pip install -e "./integrations[mcp]"

Backwards-compatible imports

These imports continue to work without any changes:

from agentflow import AgentFlowClient
from agentflow import AsyncAgentFlowClient

The SDK also preserves agentflow.retry, agentflow.circuit_breaker, and agentflow.exceptions.

Breaking imports

If you previously installed the unified agentflow package and imported runtime internals through it, those paths now fail with ModuleNotFoundError when only the SDK is installed.

Old import (v1.0.x) New import (v1.1.0) Required package
from agentflow.processing import ... from src.processing import ... agentflow-runtime
from agentflow.serving import ... from src.serving import ... agentflow-runtime
from agentflow.ingestion import ... from src.ingestion import ... agentflow-runtime
from agentflow.orchestration import ... from src.orchestration import ... agentflow-runtime

All paths under src.* are considered runtime internals. If you believe a public import path is missing, open an issue.

Pinning and lockfiles

requirements.txt

SDK users — no change:

agentflow-client>=1.1.0

Runtime operators — update the package name:

# before
agentflow>=1.0.0

# after
agentflow-runtime>=1.1.0

Poetry

# Remove old unified package
poetry remove agentflow

# Add runtime
poetry add agentflow-runtime

SDK users do not need to run the commands above; use agentflow-client in pyproject.toml.

pip-tools / pipenv

Regenerate your lockfile after updating the package name:

pip-compile requirements.in
# or
pipenv lock

Troubleshooting

ModuleNotFoundError: No module named 'agentflow.processing'

You installed only the SDK (pip install agentflow-client) but tried to import a runtime module.

Fix: Install the runtime package:

pip install agentflow-runtime

Then update imports from agentflow.* to src.* for runtime internals.

ModuleNotFoundError: No module named 'src'

You installed the SDK but expected the runtime.

Fix: The runtime package name is agentflow-runtime, not agentflow.

pip install agentflow-runtime

Can I install both packages in the same environment?

Yes. agentflow-client (SDK distribution) and agentflow-runtime do not conflict:

pip install agentflow-client agentflow-runtime

This is the setup monorepo contributors use daily.