Getting Started

Welcome to litestar-flags! This section will guide you through installing and setting up your first feature flag.

Installation

Install litestar-flags using your preferred package manager:

uv add litestar-flags

pip install litestar-flags

Or with optional dependencies for different storage backends:

Redis support:

uv add litestar-flags[redis]

pip install litestar-flags[redis]

Database support (SQLAlchemy):

uv add litestar-flags[database]

pip install litestar-flags[database]

All optional dependencies:

uv add litestar-flags[all]

pip install litestar-flags[all]

Basic Setup

Here’s a minimal example to get you started:

from litestar import Litestar, get
from litestar_flags import FeatureFlagsPlugin, FeatureFlagsConfig, FeatureFlagsClient

# Create the plugin with default configuration (in-memory storage)
config = FeatureFlagsConfig()
plugin = FeatureFlagsPlugin(config=config)

@get("/")
async def index(feature_flags: FeatureFlagsClient) -> dict:
    # Check if a feature is enabled
    if await feature_flags.is_enabled("dark_mode"):
        return {"theme": "dark"}
    return {"theme": "light"}

app = Litestar(
    route_handlers=[index],
    plugins=[plugin],
)

Creating Feature Flags

You can create feature flags programmatically:

from litestar_flags import FeatureFlag

# Simple boolean flag
dark_mode = FeatureFlag(
    name="dark_mode",
    enabled=True,
    description="Enable dark mode theme",
)

# Percentage rollout flag
new_checkout = FeatureFlag(
    name="new_checkout",
    enabled=True,
    rollout_percentage=25,  # Enable for 25% of users
    description="New checkout flow",
)

Next Steps