Installation

Requirements

Python 3.10, 3.11, or 3.12
No external services, accounts, or API keys required
No system-level dependencies

Install from PyPI

pip install flameiq-core

Verify the installation:

flameiq --version
# flameiq, version 1.0.0

flameiq --help

Install in a virtual environment (recommended)

python -m venv .venv
source .venv/bin/activate        # Linux / macOS
.venv\Scripts\activate.bat       # Windows

pip install flameiq-core
flameiq --version

Install with optional dependencies

# Include pytest-benchmark adapter
pip install flameiq-core

# Development (ruff, mypy, pre-commit, build, twine)
pip install "flameiq-core[dev]"

# Testing (pytest, pytest-cov, hypothesis)
pip install "flameiq-core[test]"

# Documentation (sphinx, sphinx-rtd-theme)
pip install "flameiq-core[docs]"

# All extras
pip install "flameiq-core[dev,test,docs]"

Install from source

git clone https://github.com/flameiq/flameiq-core.git
cd flameiq-core
pip install -e ".[dev,test,docs]"

Offline / air-gap installation

FlameIQ has zero runtime network requirements. To install in an air-gapped environment:

# On a connected machine — download wheel and all dependencies:
pip download flameiq-core --dest ./flameiq-packages

# Transfer ./flameiq-packages/ to the air-gapped system, then:
pip install flameiq-core \
    --no-index \
    --find-links ./flameiq-packages

Upgrading

pip install --upgrade flameiq-core

Note

FlameIQ follows Semantic Versioning. Patch releases (1.0.x) are backwards-compatible bug fixes only. Minor releases (1.x.0) add features in a backwards-compatible manner. Major releases (x.0.0) may introduce breaking changes.

Uninstalling

pip uninstall flameiq-core

# Also remove local FlameIQ data (baselines, history):
rm -rf .flameiq/