Skip to content

Commit 1dfbf29

Browse files
committed
refactor!: remove prefix from open_feature_* modules
Signed-off-by: Federico Bond <federicobond@gmail.com>
1 parent 288aa8a commit 1dfbf29

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

open_feature/open_feature_api.py renamed to open_feature/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import typing
22

3+
from open_feature.client import OpenFeatureClient
34
from open_feature.evaluation_context import EvaluationContext
45
from open_feature.exception import GeneralError
56
from open_feature.hooks import Hook
6-
from open_feature.open_feature_client import OpenFeatureClient
77
from open_feature.provider.metadata import Metadata
88
from open_feature.provider.no_op_provider import NoOpProvider
99
from open_feature.provider.provider import AbstractProvider

open_feature/open_feature_client.py renamed to open_feature/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import typing
33
from dataclasses import dataclass
44

5-
from open_feature import open_feature_api as api
5+
from open_feature import api
66
from open_feature.evaluation_context import EvaluationContext
77
from open_feature.exception import (
88
ErrorCode,

readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ pip install requirements.txt
6666
In order to use the sdk there is some minor configuration. Follow the script below:
6767

6868
```python
69-
from open_feature import open_feature_api
69+
from open_feature import api
7070
from open_feature.provider.no_op_provider import NoOpProvider
7171

72-
open_feature_api.set_provider(NoOpProvider())
73-
open_feature_client = open_feature_api.get_client()
72+
api.set_provider(NoOpProvider())
73+
open_feature_client = api.get_client()
7474
```
7575

7676
### Basics:
@@ -91,7 +91,7 @@ You can also bind a provider to a specific client by name instead of setting tha
9191

9292
```python
9393

94-
open_feature_api.set_provider(NoOpProvider())
94+
api.set_provider(NoOpProvider())
9595
```
9696

9797
Each provider class may have further setup required i.e. secret keys, environment variables etc
@@ -103,7 +103,7 @@ In OpenFeature, we refer to this as [`targeting`](https://openfeature.dev/specif
103103
If the flag system you're using supports targeting, you can provide the input data using the `EvaluationContext`.
104104

105105
```python
106-
from open_feature.open_feature_api import (
106+
from open_feature.api import (
107107
get_client,
108108
get_provider,
109109
set_provider
@@ -150,7 +150,7 @@ class MyHook(Hook):
150150

151151

152152
# set global hooks at the API-level
153-
from open_feature.open_feature_api import add_hooks
153+
from open_feature.api import add_hooks
154154
add_hooks([MyHook()])
155155

156156
# or configure them in the client

tests/conftest.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import pytest
22

3-
from open_feature import open_feature_api as api
3+
from open_feature import api
44
from open_feature.provider.no_op_provider import NoOpProvider
55

66

tests/features/steps/steps.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
from behave import given, then, when
44

5+
from open_feature.api import get_client, set_provider
6+
from open_feature.client import OpenFeatureClient
57
from open_feature.evaluation_context import EvaluationContext
68
from open_feature.exception import ErrorCode
79
from open_feature.flag_evaluation import FlagEvaluationDetails, Reason
8-
from open_feature.open_feature_api import get_client, set_provider
9-
from open_feature.open_feature_client import OpenFeatureClient
1010
from open_feature.provider.in_memory_provider import InMemoryProvider
1111
from tests.features.data import IN_MEMORY_FLAGS
1212

tests/test_open_feature_api.py renamed to tests/test_api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
import pytest
44

5-
from open_feature.evaluation_context import EvaluationContext
6-
from open_feature.hooks import Hook
7-
from open_feature.exception import ErrorCode, GeneralError
8-
from open_feature.open_feature_api import (
5+
from open_feature.api import (
96
get_client,
107
get_provider,
118
set_provider,
@@ -16,6 +13,9 @@
1613
add_hooks,
1714
clear_hooks,
1815
)
16+
from open_feature.evaluation_context import EvaluationContext
17+
from open_feature.exception import ErrorCode, GeneralError
18+
from open_feature.hooks import Hook
1919
from open_feature.provider.metadata import Metadata
2020
from open_feature.provider.no_op_provider import NoOpProvider
2121

tests/test_open_feature_client.py renamed to tests/test_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
import pytest
44

5-
from open_feature.open_feature_api import add_hooks, clear_hooks
5+
from open_feature.api import add_hooks, clear_hooks
6+
from open_feature.client import OpenFeatureClient
67
from open_feature.exception import ErrorCode, OpenFeatureError
78
from open_feature.flag_evaluation import Reason
89
from open_feature.hooks import Hook
9-
from open_feature.open_feature_client import OpenFeatureClient
1010
from open_feature.provider.no_op_provider import NoOpProvider
1111

1212

File renamed without changes.

0 commit comments

Comments
 (0)