Python SDK for OpenFeature
Go to file
Andrew Helsby 87c62cfae7
feat: Run a single container for sdk release (#50)
feature/release-please: Run a single container for sdk release
Signed-off-by: Andrew Helsby <ajhelsby@hotmail.com>

Signed-off-by: Andrew Helsby <ajhelsby@hotmail.com>

Signed-off-by: Andrew Helsby <ajhelsby@hotmail.com>
2022-11-15 15:59:13 +04:00
.github/workflows feat: Run a single container for sdk release (#50) 2022-11-15 15:59:13 +04:00
open_feature feat: specification-0.5.0 (#44) 2022-11-11 11:06:22 +00:00
tests feat: specification-0.5.0 (#44) 2022-11-11 11:06:22 +00:00
.env.template python-sdk: Move exceptions to a single file 2022-06-16 14:47:30 +04:00
.flake8 Restructure modules (#3) 2022-06-30 21:35:41 +04:00
.gitignore python-sdk: Work in progress initial commit of a python sdk 2022-05-12 16:11:40 +04:00
.pre-commit-config.yaml python-sdk: Fix issues raised in code review to match a more pythonic style 2022-05-30 15:13:10 +04:00
.release-please-manifest.json chore(main): release 0.0.2 (#49) 2022-11-15 15:41:16 +04:00
CHANGELOG.md chore(main): release 0.0.2 (#49) 2022-11-15 15:41:16 +04:00
LICENSE python-sdk: Work in progress initial commit of a python sdk 2022-05-12 16:11:40 +04:00
pyproject.toml chore(main): release 0.0.2 (#49) 2022-11-15 15:41:16 +04:00
readme.md feat: spec-0.2.0 (#38) 2022-11-09 15:05:35 +00:00
release-please-config.json feat: Add release please to handle releases (#45) 2022-11-15 14:51:20 +04:00
renovate.json chore(deps): add renovate.json (#29) 2022-11-02 12:21:34 +04:00
requirements-dev.in Pypi publish (#22) 2022-10-13 15:39:47 +04:00
requirements-dev.txt fix: requirements-dev.txt to reduce vulnerabilities (#37) 2022-11-03 19:50:56 -04:00
requirements.in python-sdk: Remove dependency on provider 2022-06-09 16:59:20 +04:00
requirements.txt Pypi publish (#22) 2022-10-13 15:39:47 +04:00

readme.md

Open Feature SDK for Python

PyPI version Python 3.8+ Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Specification on-merge codecov

This is the Python implementation of OpenFeature, a vendor-agnostic abstraction library for evaluating feature flags.

We support multiple data types for flags (numbers, strings, booleans, objects) as well as hooks, which can alter the lifecycle of a flag evaluation.

This library is intended to be used in server-side contexts and has not been evaluated for use in mobile devices.

Usage

While Boolean provides the simplest introduction, we offer a variety of flag types.

# Depending on the flag type, use one of the methods below
flag_key = "PROVIDER_FLAG"
boolean_result = open_feature_client.get_boolean_value(key=flag_key,default_value=False)
integer_result = open_feature_client.get_integer_value(key=flag_key,default_value=-1)
float_result = open_feature_client.get_float_value(key=flag_key,default_value=-1)
string_result = open_feature_client.get_string_value(key=flag_key,default_value="")
object_result = open_feature_client.get_object_value(key=flag_key,default_value={})

Each provider class may have further setup required i.e. secret keys, environment variables etc

Requirements

  • Python 3.8+

Installation

Add it to your build

Pip install

pip install python-open-feature-sdk==0.0.1

requirements.txt

python-open-feature-sdk==0.0.1
pip install requirements.txt

Configure it

In order to use the sdk there is some minor configuration. Follow the script below:

from open_feature import open_feature_api

open_feature_api.set_provider(NoOpProvider())
open_feature_client = open_feature_api.get_client()

Contacting us

We hold regular meetings which you can see here.

We are also present on the #openfeature channel in the CNCF slack.

Contributors

Thanks so much to our contributors.

Made with contrib.rocks.