Installation¶

Requirements¶

Before installing Flux, ensure you have:

Python 3.12 or later
pip (Python package installer)
Optional: Poetry for dependency management

Core Dependencies¶

Flux relies on the following packages:

pydantic = "^2.9.2"
sqlalchemy = "^2.0.35"
fastapi = "^0.115.2"
uvicorn = "^0.31.1"
pycryptodome = "^3.21.0"

Storage Requirements¶

Write access to create a .data directory for SQLite database storage
Sufficient disk space for state persistence

Installation Guide¶

Using pip¶

pip install flux-core

Using Poetry¶

# Initialize a new project
poetry init

# Add Flux as a dependency
poetry add flux-core

# Enter the virtual environment
poetry shell

Installing for Development¶

If you're planning to contribute or need development tools:

git clone https://github.com/edurdias/flux
cd flux
poetry install

This will install additional development dependencies for testing and code quality: - pytest and related plugins for testing - pylint, pyright, and other linting tools - pre-commit hooks for code quality

Quick Setup¶

Verify Installation Check that Flux is properly installed by creating a simple test workflow:

from flux import task, workflow, WorkflowExecutionContext

@task
async def say_hello(name: str):
    return f"Hello, {name}"

@workflow
async def hello_world(ctx: WorkflowExecutionContext[str]):
    return await say_hello(ctx.input)

Run the Workflow You can execute workflows in three ways:

# Python
ctx = hello_world.run("World")
print(ctx.output)

# Command Line
flux exec hello_world.py hello_world "World"

# HTTP API
flux start examples
curl --location 'localhost:8000/hello_world' \
     --header 'Content-Type: application/json' \
     --data '"World"'

Directory Structure Flux will automatically create its required directories:

your-project/
├── .data/          # SQLite database and state storage
└── your_workflows/

Next Steps
Create your first workflow using the examples
Learn about core concepts
Explore advanced features