Skip to content

Commit b07325f

Browse files
committed
readme updates
1 parent 1b4d79b commit b07325f

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Featurevisor Python SDK
22

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.
44

55
The package name is `featurevisor`, and it targets Python 3.10+.
66

7+
This SDK is compatible with [Featurevisor](https://featurevisor.com/) v2.0 projects and above.
8+
79
<!-- FEATUREVISOR_DOCS_BEGIN -->
810

911
## Installation
@@ -34,11 +36,11 @@ f = create_instance({
3436

3537
## Evaluation Types
3638

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/):
3840

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)
4244

4345
## Context
4446

@@ -232,9 +234,9 @@ f.close()
232234
The Python package also exposes a CLI:
233235

234236
```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
238240
```
239241

240242
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
244246
Run Featurevisor test specs using the Python SDK:
245247

246248
```bash
247-
featurevisor test \
249+
python -m featurevisor test \
248250
--projectDirectoryPath=/path/to/featurevisor-project
249251
```
250252

251253
Useful options:
252254

253255
```bash
254-
featurevisor test --keyPattern=foo
255-
featurevisor test --assertionPattern=variation
256-
featurevisor test --onlyFailures
257-
featurevisor test --showDatafile
258-
featurevisor test --verbose
259-
featurevisor test --with-tags
260-
featurevisor test --with-scopes
256+
python -m featurevisor test --keyPattern=foo
257+
python -m featurevisor test --assertionPattern=variation
258+
python -m featurevisor test --onlyFailures
259+
python -m featurevisor test --showDatafile
260+
python -m featurevisor test --verbose
261+
python -m featurevisor test --with-tags
262+
python -m featurevisor test --with-scopes
261263
```
262264

263265
### Benchmark
264266

265267
Benchmark repeated Python SDK evaluations against a built datafile:
266268

267269
```bash
268-
featurevisor benchmark \
270+
python -m featurevisor benchmark \
269271
--projectDirectoryPath=/path/to/featurevisor-project \
270272
--environment=production \
271273
--feature=my_feature \
@@ -276,7 +278,7 @@ featurevisor benchmark \
276278
For variation benchmarks:
277279

278280
```bash
279-
featurevisor benchmark \
281+
python -m featurevisor benchmark \
280282
--projectDirectoryPath=/path/to/featurevisor-project \
281283
--environment=production \
282284
--feature=my_feature \
@@ -287,7 +289,7 @@ featurevisor benchmark \
287289
For variable benchmarks:
288290

289291
```bash
290-
featurevisor benchmark \
292+
python -m featurevisor benchmark \
291293
--projectDirectoryPath=/path/to/featurevisor-project \
292294
--environment=production \
293295
--feature=my_feature \
@@ -300,7 +302,7 @@ featurevisor benchmark \
300302
Inspect enabled/disabled and variation distribution over repeated evaluations:
301303

302304
```bash
303-
featurevisor assess-distribution \
305+
python -m featurevisor assess-distribution \
304306
--projectDirectoryPath=/path/to/featurevisor-project \
305307
--environment=production \
306308
--feature=my_feature \
@@ -311,7 +313,7 @@ featurevisor assess-distribution \
311313
You can also populate UUID-based context keys per iteration:
312314

313315
```bash
314-
featurevisor assess-distribution \
316+
python -m featurevisor assess-distribution \
315317
--projectDirectoryPath=/path/to/featurevisor-project \
316318
--environment=production \
317319
--feature=my_feature \

0 commit comments

Comments
 (0)