Installation¶

This page covers detailed installation instructions for litestar-flags.

Requirements¶

The simplest way to install litestar-flags is via your preferred package manager:

uv (Recommended)

uv add litestar-flags

pip

pip install litestar-flags

litestar-flags supports multiple storage backends through optional dependencies:

For distributed feature flag storage using Redis:

uv (Recommended)

uv add litestar-flags[redis]

pip

pip install litestar-flags[redis]

This installs redis>=5.0.0 as a dependency.

For persistent storage using SQLAlchemy (supports PostgreSQL, MySQL, SQLite, etc.):

uv (Recommended)

uv add litestar-flags[database]

pip

pip install litestar-flags[database]

This installs advanced-alchemy>=0.10.0 and sqlalchemy[asyncio]>=2.0.0.

For approval workflows and governance features using litestar-workflows:

uv (Recommended)

uv add litestar-flags[workflows]

pip

pip install litestar-flags[workflows]

This installs litestar-workflows>=0.1.0 for human-in-the-loop approval workflows, scheduled rollouts, and auditable flag changes.

To install all optional dependencies:

uv (Recommended)

uv add litestar-flags[all]

pip

pip install litestar-flags[all]

For contributing to litestar-flags:

git clone https://github.com/JacobCoffee/litestar-flags.git
cd litestar-flags

uv (Recommended)

uv sync

pip

pip install -e ".[dev]"

You can verify the installation by importing the package:

>>> import litestar_flags
>>> print(litestar_flags.__version__)
0.1.0