Skip to content

How to install

Installation

uv add llmfy

pip install llmfy

Prerequisites Package

Package Required/Optional Purpose How to Install
pydantic ✅ Required Core dependency Auto-installed with llmfy
openai 🔸 Optional Use OpenAI models pip install "llmfy[openai]"
boto3 🔸 Optional Use AWS Bedrock models pip install "llmfy[boto3]"
google-genai 🔸 Optional Use Google AI (Gemini) models pip install "llmfy[google-genai]"
numpy 🔸 Optional Use Embedding, FAISSVectorStore pip install "llmfy[numpy]"
faiss-cpu 🔸 Optional Use FAISSVectorStore pip install "llmfy[faiss-cpu]"
typing_extensions 🔸 Optional Use state in FlowEngine pip install "llmfy[typing_extensions]"
redis 🔸 Optional Use RedisCheckpointer pip install "llmfy[redis]"
SQLAlchemy 🔸 Optional Use SQLCheckpointer (supports sync and async drivers) pip install "llmfy[SQLAlchemy]"

  • SQLCheckpointer

    Package Required/Optional Purpose How to Install
    asyncpg 🔸 Optional PostgreSQL async driver for SQLCheckpointer pip install asyncpg
    psycopg2 🔸 Optional PostgreSQL sync driver for SQLCheckpointer pip install psycopg2
    aiomysql 🔸 Optional MySQL async driver for SQLCheckpointer pip install aiomysql
    pymysql 🔸 Optional MySQL sync driver for SQLCheckpointer pip install pymysql
    aiosqlite 🔸 Optional SQLite async driver for SQLCheckpointer pip install aiosqlite

Provider-specific extras

Install only the provider packages you need:

# OpenAI support
uv add "llmfy[openai]"

# AWS Bedrock support
uv add "llmfy[boto3]"

# Google AI (Gemini) support
uv add "llmfy[google-genai]"

# Install all optional dependencies
uv add "llmfy[all]"

# OpenAI support
pip install "llmfy[openai]"

# AWS Bedrock support
pip install "llmfy[boto3]"

# Google AI (Gemini) support
pip install "llmfy[google-genai]"

# Install all optional dependencies
pip install "llmfy[all]"