Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Open Feature SDK for Python
# OpenFeature SDK for Python

[![PyPI version](https://badge.fury.io/py/openfeature-sdk.svg)](https://badge.fury.io/py/openfeature-sdk)
![Python 3.8+](https://img.shields.io/badge/python->=3.8-blue.svg)
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
Expand All @@ -8,13 +9,14 @@

This is the Python implementation of [OpenFeature](https://openfeature.dev), 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.
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.

```python
# Depending on the flag type, use one of the methods below
flag_key = "PROVIDER_FLAG"
Expand All @@ -24,27 +26,39 @@ 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

<!---x-release-please-start-version-->

Pip install

```bash
pip install python-open-feature-sdk==0.0.1
pip install python-open-feature-sdk==0.0.4
```

requirements.txt

```bash
python-open-feature-sdk==0.0.1
python-open-feature-sdk==0.0.4
```

```python
pip install requirements.txt
```

<!---x-release-please-end-->

### Configure it

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

```python
Expand All @@ -55,6 +69,7 @@ open_feature_client = open_feature_api.get_client()
```

## Contacting us

We hold regular meetings which you can see [here](https://github.com/open-feature/community/#meetings-and-events).

We are also present on the `#openfeature` channel in the [CNCF slack](https://slack.cncf.io/).
Expand All @@ -67,5 +82,4 @@ Thanks so much to our contributors.
<img src="https://contrib.rocks/image?repo=open-feature/python-sdk" />
</a>


Made with [contrib.rocks](https://contrib.rocks).
Made with [contrib.rocks](https://contrib.rocks).