Skip to main content

Simple feature-flag module with per-tenant overrides and a consumer API for simple_module

Project description

simple_module_feature_flags

Feature flags for simple_module apps. Global flags with per-tenant overrides, a tiny consumer API, and no external service to run.

Install

pip install simple_module_feature_flags

What it provides

  • Flags are declared via the framework register_feature_flags hook (FeatureFlagDefinition(name, default_enabled=...)); the module persists only overrides in the feature_flags_override SQLModel table (scoped by scope / scope_id).
  • FeatureFlagRegistry.is_enabled("flag.name", tenant_id=...) consumer API (resolution order: tenant override > system override > declared default).
  • Admin UI at /feature_flags — toggle flags, add per-scope overrides.
  • The registry is an in-memory cache hydrated from the DB so checking a flag on every request is cheap.

Usage

Declare a flag in your module:

from simple_module_core.feature_flags import FeatureFlagDefinition, FeatureFlagRegistry


class OrdersModule(ModuleBase):
    def register_feature_flags(self, registry: FeatureFlagRegistry) -> None:
        registry.add(FeatureFlagDefinition(name="orders.new_pricing_engine", default_enabled=False))

Gate a route using the registry dependency:

from fastapi import APIRouter, HTTPException

from feature_flags.deps import FeatureFlagRegistryDep   # type: ignore[import-not-found]

router = APIRouter()


@router.get("/new-feature")
async def new_feature(flags: FeatureFlagRegistryDep):
    if not flags.is_enabled("orders.new_pricing_engine"):
        raise HTTPException(404)
    return {"rolled_out": True}

Overrides (system or per-tenant) are managed through the admin UI at /feature_flags.

Depends on

  • simple_module_core, simple_module_db, simple_module_hosting

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_module_feature_flags-0.0.21.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_module_feature_flags-0.0.21-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file simple_module_feature_flags-0.0.21.tar.gz.

File metadata

File hashes

Hashes for simple_module_feature_flags-0.0.21.tar.gz
Algorithm Hash digest
SHA256 ea1d857d40acba0962c6dfbe18ca180460b617a47d20e71b3312c17bce50c582
MD5 9867f444b6898b40cc0b0554551af896
BLAKE2b-256 1b4927c8e2827c3f36fe4929c8913ea6a78d6a48c9324e560c52f1d535d08845

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_feature_flags-0.0.21.tar.gz:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simple_module_feature_flags-0.0.21-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_feature_flags-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 81e9c707a1e0e82eb6b43ea9402cfc5814232322c2dc23d89562222376cdb2f7
MD5 3d4977a8c3dfc02e9c65414fcd9c6048
BLAKE2b-256 716e8877163c5704706c184ec51c6064eb64d3d9b34b338735a014fbaee095b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_feature_flags-0.0.21-py3-none-any.whl:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page