You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Featurevisor Python SDK
2
2
3
-
This repository ports the latest Featurevisor JavaScript SDK to Python and includes a companion CLI for SDK validation tasks like `test`, `benchmark`, and `assess-distribution`.
3
+
This repository ports the latest Featurevisor [JavaScript SDK](https://featurevisor.com/docs/sdks/javascript/) to Python.
4
4
5
5
The package name is `featurevisor`, and it targets Python 3.10+.
6
6
7
+
This SDK is compatible with [Featurevisor](https://featurevisor.com/) v2.0 projects and above.
8
+
7
9
<!-- FEATUREVISOR_DOCS_BEGIN -->
8
10
9
11
## Installation
@@ -34,11 +36,11 @@ f = create_instance({
34
36
35
37
## Evaluation Types
36
38
37
-
The SDK evaluates three kinds of values against a feature:
39
+
We can evaluate 3 types of values against a particular [feature](https://featurevisor.com/docs/features/):
38
40
39
-
- Flag: whether the feature is enabled.
40
-
- Variation: the selected variation value.
41
-
- Variables: any variable values defined on the feature.
41
+
-[**Flag**](#check-if-enabled) (`bool`): whether the feature is enabled or not
42
+
-[**Variation**](#getting-variation) (`string`): the variation of the feature (if any)
43
+
-[**Variables**](#getting-variables): variable values of the feature (if any)
42
44
43
45
## Context
44
46
@@ -232,9 +234,9 @@ f.close()
232
234
The Python package also exposes a CLI:
233
235
234
236
```bash
235
-
featurevisor test
236
-
featurevisor benchmark
237
-
featurevisor assess-distribution
237
+
python -m featurevisor test
238
+
python -m featurevisor benchmark
239
+
python -m featurevisor assess-distribution
238
240
```
239
241
240
242
These commands are intended for use from inside a Featurevisor project and rely on `npx featurevisor` being available locally.
@@ -244,28 +246,28 @@ These commands are intended for use from inside a Featurevisor project and rely
0 commit comments