Skip to main content

Feature Flags for FastAPI

Project description

Test Python package codecov Upload Python Package to PyPI PythonVersions Sourcery Black Snyk Downloads Twitter Follow

FastAPI Feature Flags

Very simple implementation of feature flags for FastAPI.

  • Minimum configuration required
  • No unnecessary dependencies
  • Does its job

Installing

To install the package from pip, first run:

pip install fastapi-featureflags

Usage

A simple example of feature flags:

from fastapi_featureflags import FeatureFlags, feature_flag, feature_enabled

FeatureFlags(conf_from_url="https://pastebin.com/raw/4Ai3j2DC")
print("Enabled Features:", FeatureFlags.get_features())


@feature_flag("web_1")
def web_1_enabled():
    print("Feature Should be enabled: web_1")

web_1_enabled()

if feature_enabled("web_2"):
    print("Feature Should be disabled: web_2")

You can get FF (feature flags) from a File, URL, Dictionary or ENV Variables:

FeatureFlags.load_conf_from_url("https://pastebin.com/raw/4Ai3j2DC")
FeatureFlags.load_conf_from_json("tests/features.json")
FeatureFlags.load_conf_from_dict({"web_1": True, "web_2": False})

FeatureFlags.reload_feature_flags()

There is also a handler that recognizes if the "@feature_flag" wrapper is used and the flag is not registered in the config. This way you can also use FF at runtime. Defaults to False, so it's safer if you forget the feature flag in the code.

Function get_features returns a list of all registered FF
You can enable or disable functions on the fly with enable_feature or enable_feature

When needed you can reload all feature flags with reload_feature_flags, this is useful when you want to read and change features from URL. All unregistered or on-the-fly created FF, that are not in the configuration will be omitted.

For non-production testing, a router is available, so you can see the paths in swagger-ui docs. Use include_in_schema=False when defining the router for public deployments

from fastapi_featureflags import router as ff_router
app.include_router(ff_router, prefix="/ff", tags=["FeatureFlags"])

FastAPI-FF

Contributing and Code of Conduct

Contributing to fastapi-featureflags

As an open source project, fastapi-featureflags welcomes contributions of many forms.
Please read and follow our Contributing to fastapi-featureflags

Code of Conduct

As a contributor, you can help us keep the fastapi-featureflags project open and inclusive.
Please read and follow our Code of Conduct

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

fastapi_featureflags-0.4.9.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

fastapi_featureflags-0.4.9-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_featureflags-0.4.9.tar.gz.

File metadata

  • Download URL: fastapi_featureflags-0.4.9.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for fastapi_featureflags-0.4.9.tar.gz
Algorithm Hash digest
SHA256 acfef5875a7f0320681351d509ed29573dc31704ca43579731a68d5c32872eb4
MD5 2885a8459fc839ad5f06d148c6dcba65
BLAKE2b-256 0ec91b0da963a4bf8e055787b1cb6ca122d39d79d82dc0567a755a77daaf43d9

See more details on using hashes here.

File details

Details for the file fastapi_featureflags-0.4.9-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_featureflags-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 544ad2a1004e060fe78a45946227bad8079ad206bee5e60877e7b051f5ab9eb5
MD5 bd769df7f24d919b1555074b9a2f89e8
BLAKE2b-256 caff660f524381d18eb8ec8ed782c41e1ccd4061c27faf665c0947feb9c6e171

See more details on using hashes here.

Supported by

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