Python SDK installation
Install the open-source ArcFlow Python SDK from PyPI. The distribution name is arcflow-sdk; you import arcflow in application code.
Install from PyPI
1. Create a virtual environment (recommended)
macOS and Linux:
Windows (PowerShell):
2. Install the package
Pin a release:
3. Verify
Requirements
| Requirement | Notes |
|---|---|
| Python | 3.9 through 3.12 (match a published wheel tag on PyPI files) |
| pip | Current pip recommended |
| Rust | Not required for pip install (prebuilt wheels include the native extension) |
| Platforms | Linux, macOS, and Windows wheels are published from CI |
Optional extras
LangChain adapter:
If the extra is not installed, import arcflow.langchain fails with a missing dependency error.
Provider API keys
Set keys in the environment before calling run(..., provider=...):
| Provider | Environment variable |
|---|---|
| OpenAI | OPENAI_API_KEY |
| Anthropic | ANTHROPIC_API_KEY |
| Gemini | GEMINI_API_KEY |
Credentials are never passed through workflow JSON. The runtime reads them at execution time.
Local memory stack (optional)
For persistent or vector memory during development:
Session and shared memory types work without Docker.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
No matching distribution / wrong Python | No wheel for your Python version or OS | Check PyPI files; use Python 3.9–3.12 on a supported platform |
ImportError: arcflow._arcflow_binding after pip install | Broken or partial install | pip install --force-reinstall arcflow-sdk in a fresh venv |
ImportError: arcflow | Package not installed in active venv | Activate venv; run pip install arcflow-sdk |
| LangChain import fails | Extra not installed | pip install "arcflow-sdk[langchain]" |
InfrastructureUnavailableError on vector run | Qdrant URL unset or down | Start Docker stack; export ARCFLOW_QDRANT_URL |
InfrastructureUnavailableError on recovery | Postgres URL unset | Export ARCFLOW_POSTGRESQL_URL; run migrations |
To build the SDK from the monorepo (contributors), see the ArcFlow repository.
Related pages
| Page | Content |
|---|---|
| Overview | Architecture and capabilities |
| the ArcFlow repository | Build from source in the ArcFlow repository |
| Quickstart | First workflow |
| Install and build (all SDKs) | Python and TypeScript |