Skip to content

Commit bfb13d7

Browse files
authored
chore: update readme to include latest pip version (#54)
Signed-off-by: Michael Beemer <[email protected]>
1 parent 47e1d3f commit bfb13d7

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

readme.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Open Feature SDK for Python
1+
# OpenFeature SDK for Python
2+
23
[![PyPI version](https://badge.fury.io/py/openfeature-sdk.svg)](https://badge.fury.io/py/openfeature-sdk)
34
![Python 3.8+](https://img.shields.io/badge/python->=3.8-blue.svg)
45
[![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)
@@ -8,13 +9,14 @@
89

910
This is the Python implementation of [OpenFeature](https://openfeature.dev), a vendor-agnostic abstraction library for evaluating feature flags.
1011

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

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

15-
1616
## Usage
17+
1718
While Boolean provides the simplest introduction, we offer a variety of flag types.
19+
1820
```python
1921
# Depending on the flag type, use one of the methods below
2022
flag_key = "PROVIDER_FLAG"
@@ -24,27 +26,39 @@ float_result = open_feature_client.get_float_value(key=flag_key,default_value=-1
2426
string_result = open_feature_client.get_string_value(key=flag_key,default_value="")
2527
object_result = open_feature_client.get_object_value(key=flag_key,default_value={})
2628
```
29+
2730
Each provider class may have further setup required i.e. secret keys, environment variables etc
2831

2932
## Requirements
33+
3034
- Python 3.8+
3135

3236
## Installation
37+
3338
### Add it to your build
39+
40+
<!---x-release-please-start-version-->
41+
3442
Pip install
43+
3544
```bash
36-
pip install python-open-feature-sdk==0.0.1
45+
pip install python-open-feature-sdk==0.0.4
3746
```
3847

3948
requirements.txt
49+
4050
```bash
41-
python-open-feature-sdk==0.0.1
51+
python-open-feature-sdk==0.0.4
4252
```
53+
4354
```python
4455
pip install requirements.txt
4556
```
4657

58+
<!---x-release-please-end-->
59+
4760
### Configure it
61+
4862
In order to use the sdk there is some minor configuration. Follow the script below:
4963

5064
```python
@@ -55,6 +69,7 @@ open_feature_client = open_feature_api.get_client()
5569
```
5670

5771
## Contacting us
72+
5873
We hold regular meetings which you can see [here](https://github.com/open-feature/community/#meetings-and-events).
5974

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

70-
71-
Made with [contrib.rocks](https://contrib.rocks).
85+
Made with [contrib.rocks](https://contrib.rocks).

0 commit comments

Comments
 (0)