Skip to content

updated readme #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chillaq merged 1 commit into from
Nov 10, 2025
Merged

updated readme #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ This SDK is compatible with Python 3.9 and higher.
## Getting started
### Pip Installation
```python
pip install split-openfeature==1.0.0
pip install split-openfeature-provider==1.0.0
```
### Configure it
Below is a simple example that describes using the Split Provider. Please see the [OpenFeature Documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api) for details on how to use the OpenFeature SDK.

```python
from openfeature import api
from split_openfeature import SplitProvider
from split_openfeature_provider import SplitProvider
config = {
'impressionsMode': 'OPTIMIZED',
'impressionsRefreshRate': 30,
Expand All @@ -29,7 +29,7 @@ api.set_provider(provider)
If you are more familiar with Split or want access to other initialization options, you can provide a Split `client` to the constructor. See the [Harness Split Python SDK Documentation](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/python-sdk/) for more information.
```python
from openfeature import api
from split_openfeature import SplitProvider
from split_openfeature_provider import SplitProvider
from splitio import get_factory

config = {
Expand Down Expand Up @@ -72,7 +72,7 @@ Example below shows using the provider in asyncio

```python
from openfeature import api
from split_openfeature import SplitProviderAsync
from split_openfeature_provider import SplitProviderAsync
config = {
'impressionsMode': 'OPTIMIZED',
'impressionsRefreshRate': 30,
Expand All @@ -85,7 +85,7 @@ api.set_provider(provider)
Example below show how to create the Split Client externally and pass it to Provider
```python
from openfeature import api
from split_openfeature import SplitProviderAsync
from split_openfeature_provider import SplitProviderAsync
from splitio import get_factory_async

config = {
Expand Down