Installation

Requirements

• Python 3.10 or higher
• pip or uv package manager

Basic Installation

Install FlowPrompt with pip:

pip install flowprompt-ai

Or with uv:

uv add flowprompt-ai

Installation Options

With CLI Tools

pip install flowprompt-ai[cli]

With OpenTelemetry Tracing

pip install flowprompt-ai[tracing]

With All Features

pip install flowprompt-ai[all]

Provider Setup

FlowPrompt uses LiteLLM under the hood, so you need to set up API keys for your chosen provider.

OpenAI

export OPENAI_API_KEY="sk-..."

Anthropic

export ANTHROPIC_API_KEY="sk-ant-..."

Google (Gemini)

export GEMINI_API_KEY="..."

Local Models (Ollama)

No API key needed. Just ensure Ollama is running:

ollama serve

Verify Installation

import flowprompt

print(flowprompt.__version__)  # e.g. "0.5.0"

Development Installation

For contributing to FlowPrompt:

git clone https://github.com/yotambraun/flowprompt.git
cd flowprompt
uv venv
uv sync --all-extras

Run tests to verify:

uv run pytest
uv run python scripts/run_examples.py   # every example, offline

Build the documentation site locally:

uv sync --group docs
uv run mkdocs serve          # or: uv run mkdocs build --strict

Next Steps

Continue to the Quick Start guide to create your first prompt.