initial commit

Author: fahad19

.github/workflows/checks.yml

@@ -0,0 +1,22 @@
+name: Checks
+
+on:
+  push:
+    branches: ["**"]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: make install
+
+      - name: Run app
+        run: make build

.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.DS_Store

Makefile

@@ -0,0 +1,11 @@
+PYTHON := .venv/bin/python
+PIP := .venv/bin/pip
+
+.PHONY: install build
+
+install:
+	python3 -m venv .venv
+	$(PIP) install -r requirements.txt
+
+build:
+	$(PYTHON) main.py

README.md

@@ -0,0 +1,46 @@
+# featurevisor-example-python
+
+Tiny example application using the Featurevisor Python SDK.
+
+It mirrors the Go example by:
+
+- fetching a remote Featurevisor datafile,
+- creating a Featurevisor instance,
+- setting evaluation context inside the script,
+- printing whether a feature is enabled.
+
+The example uses this datafile:
+
+[https://featurevisor-example-cloudflare.pages.dev/production/featurevisor-tag-all.json](https://featurevisor-example-cloudflare.pages.dev/production/featurevisor-tag-all.json)
+
+## Requirements
+
+- Python 3.10+
+
+## Installation
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Usage
+
+```bash
+python main.py
+```
+
+## What It Does
+
+The script fetches the remote datafile, builds a Featurevisor instance, sets this default context, and evaluates a feature:
+
+```json
+{
+  "userId": "123",
+  "deviceId": "device-23456",
+  "country": "nl"
+}
+```
+
+It evaluates `my_feature`, which exists in the sample datafile.

main.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+import json
+import sys
+from urllib.error import HTTPError, URLError
+from urllib.request import Request, urlopen
+
+from featurevisor import create_instance
+
+DATAFILE_URL = "https://featurevisor-example-cloudflare.pages.dev/production/featurevisor-tag-all.json"
+FEATURE_KEY = "my_feature"
+CONTEXT = {
+    "userId": "123",
+    "deviceId": "device-23456",
+    "country": "nl",
+}
+
+
+def fetch_datafile(url: str) -> dict:
+    try:
+        request = Request(
+            url,
+            headers={
+                "User-Agent": "featurevisor-example-python/1.0",
+                "Accept": "application/json",
+            },
+        )
+        with urlopen(request) as response:
+            return json.load(response)
+    except HTTPError as exc:
+        raise RuntimeError(f"failed to fetch datafile: HTTP {exc.code}") from exc
+    except URLError as exc:
+        raise RuntimeError(f"failed to fetch datafile: {exc.reason}") from exc
+
+
+def main() -> int:
+    try:
+        datafile = fetch_datafile(DATAFILE_URL)
+        f = create_instance({"datafile": datafile, "logLevel": "error"})
+        f.set_context(CONTEXT)
+        enabled = f.is_enabled(FEATURE_KEY)
+    except Exception as exc:
+        print(f"Error: {exc}", file=sys.stderr)
+        return 1
+
+    print(f"Datafile revision: {f.get_revision()}")
+    print(f"Context: {json.dumps(CONTEXT)}")
+    print(f"Feature '{FEATURE_KEY}' enabled: {enabled}")
+    print(f"All evaluations: {json.dumps(f.get_all_evaluations(), sort_keys=True)}")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

requirements.txt

@@ -0,0 +1 @@
+featurevisor==0.2.0