Installation¶

Requirements¶

Python 3.9 or higher
pip (included with Python)
Node.js 18+ and npm (optional, only for frontend/monorepo features)

Install Honey Badgeria¶

Core Package¶

pip install honey-badgeria

The core package includes the graph model, execution engine, data flow system, contracts, atomicity, SAGA pattern, and testing framework. Add extras only when you need integrations or tooling.

With Optional Extras¶

# YAML support (required for loading .yaml flow files)
pip install honey-badgeria[yaml]

# CLI tools
pip install honey-badgeria[cli]

# Graph visualization (Graphviz)
pip install honey-badgeria[viz]

# FastAPI integration
pip install honey-badgeria[fastapi]

# All optional dependencies
pip install honey-badgeria[all]

# Development (includes pytest, httpx, and all extras)
pip install honey-badgeria[dev]

What Each Extra Provides¶

Extra	Packages	What It Enables
`yaml`	`pyyaml>=6.0`	Loading YAML flow definitions
`cli`	`typer>=0.9`	The `hbia` command-line tool
`viz`	`graphviz>=0.20`	Graphviz SVG/PNG rendering
`fastapi`	`fastapi>=0.100`	FastAPI auto-route integration
`dev`	All of the above + `pytest`, `httpx`, `mkdocs`	Full development environment
`all`	`pyyaml`, `typer`, `graphviz`, `fastapi`	Everything except test tools

Verify Installation¶

python -c "import honey_badgeria; print('OK')"

If you installed the CLI extra:

hbia version

Development Install (From Source)¶

git clone https://github.com/honey-badgeria/honey-badgeria.git
cd honey-badgeria
pip install -e ".[dev]"

This installs the package in editable mode with all development dependencies.

What's Next?¶

Once installed, scaffold your first project:

hbia init my_project
cd my_project

First Steps