feat(python): allow setting arbitrary headers (#175)

flipt-java/src/main/java/example/Main.java → flipt-java/src/main/java/examples/Main.java

@@ -1,4 +1,4 @@
-package example;
+package examples;
 
 import io.flipt.api.FliptClient;
 import io.flipt.api.evaluation.models.*;

flipt-node/package.json

@@ -7,8 +7,8 @@
   "author": "Flipt Devs <dev@flipt.io>",
   "license": "MIT",
   "scripts": {
-    "fmt": "prettier --config .prettierrc 'src/**/*.ts' 'example/index.ts' --write",
-    "lint": "prettier --check src/**/*.ts example/index.ts",
+    "fmt": "prettier --config .prettierrc 'src/**/*.ts' 'examples/index.ts' --write",
+    "lint": "prettier --check src/**/*.ts examples/index.ts",
     "test": "jest",
     "build": "tsc"
   },

flipt-python/README.md

@@ -38,10 +38,9 @@ print(variant_flag)
 
 There is a more detailed example in the [examples](./examples) directory.
 
-
 ## For developers
 
 After adding new code, please don't forget to add unit tests for new features.
-To format the code, check it with linters and run tests, use the `make check` command. 
+To format the code, check it with linters and run tests, use the `make check` command.
 
 Please keep the Python [PEP8](https://peps.python.org/pep-0008/) in mind while adding new code.

flipt-python/example/async_client.py → flipt-python/examples/async_client.py

@@ -1,11 +1,23 @@
 import asyncio
+import base64
+import os
 
 from flipt import AsyncFliptClient
 from flipt.evaluation import BatchEvaluationRequest, EvaluationRequest
 
 
 async def main():
-    flipt_client = AsyncFliptClient()
+    # Set up the headers with the basic auth credentials
+    # for example if Flipt is behind a reverse proxy
+
+    headers = {}
+    username = os.getenv("FLIPT_USERNAME") or "admin"
+    password = os.getenv("FLIPT_PASSWORD") or "admin"
+
+    b64_creds = base64.b64encode(f"{username}:{password}".encode("utf-8")).decode("utf-8")
+    headers["Authorization"] = f"Basic {b64_creds}')"
+
+    flipt_client = AsyncFliptClient(headers=headers)
 
     variant_flag = await flipt_client.evaluation.variant(
         EvaluationRequest(

flipt-python/example/sync_client.py → flipt-python/examples/sync_client.py

@@ -1,7 +1,19 @@
 from flipt import FliptClient
 from flipt.evaluation import BatchEvaluationRequest, EvaluationRequest
+import base64
+import os
 
-flipt_client = FliptClient()
+# Set up the headers with the basic auth credentials
+# for example if Flipt is behind a reverse proxy
+headers = {}
+
+username = os.getenv("FLIPT_USERNAME") or "admin"
+password = os.getenv("FLIPT_PASSWORD") or "admin"
+
+b64_creds = base64.b64encode(f"{username}:{password}".encode("utf-8")).decode("utf-8")
+headers["Authorization"] = f"Basic {b64_creds}')"
+
+flipt_client = FliptClient(headers=headers)
 
 variant_flag = flipt_client.evaluation.variant(
     EvaluationRequest(

flipt-python/flipt/async_client.py

@@ -9,13 +9,14 @@ class AsyncFliptClient:
     def __init__(
         self,
         url: str = "http://localhost:8080",
+        headers: dict[str, str] | None = None,
         timeout: int = 60,
         authentication: AuthenticationStrategy | None = None,
     ):
         self.httpx_client = httpx.AsyncClient(timeout=timeout)
 
-        self.evaluation = AsyncEvaluation(url, authentication, self.httpx_client)
-        self.flag = AsyncFlag(url, authentication, self.httpx_client)
+        self.evaluation = AsyncEvaluation(url, headers, authentication, self.httpx_client)
+        self.flag = AsyncFlag(url, headers, authentication, self.httpx_client)
 
     async def close(self) -> None:
         await self.httpx_client.aclose()

flipt-python/flipt/evaluation/async_evaluation_client.py

@@ -18,11 +18,15 @@ class AsyncEvaluation:
     def __init__(
         self,
         url: str,
+        headers: dict[str, str] | None = None,
         authentication: AuthenticationStrategy | None = None,
         httpx_client: httpx.AsyncClient | None = None,
     ):
         self.url = url
-        self.headers: dict[str, str] = {}
+
+        if headers is None:
+            headers = {}
+        self.headers = headers
 
         self._client = httpx_client or httpx.AsyncClient()
 

flipt-python/flipt/evaluation/sync_evaluation_client.py

@@ -18,11 +18,15 @@ class Evaluation:
     def __init__(
         self,
         url: str,
+        headers: dict[str, str] | None = None,
         authentication: AuthenticationStrategy | None = None,
         httpx_client: httpx.Client | None = None,
     ):
         self.url = url
-        self.headers: dict[str, str] = {}
+
+        if headers is None:
+            headers = {}
+        self.headers = headers
 
         self._client = httpx_client or httpx.Client()
 

flipt-python/flipt/flags/async_flag_client.py

@@ -13,11 +13,15 @@ class AsyncFlag:
     def __init__(
         self,
         url: str,
+        headers: dict[str, str] | None = None,
         authentication: AuthenticationStrategy | None = None,
         httpx_client: httpx.AsyncClient | None = None,
     ):
         self.url = url
-        self.headers: dict[str, str] = {}
+
+        if headers is None:
+            headers = {}
+        self.headers = headers
 
         self._client = httpx_client or httpx.AsyncClient()
 

flipt-python/flipt/flags/sync_flag_client.py

@@ -13,11 +13,15 @@ class SyncFlag:
     def __init__(
         self,
         url: str,
+        headers: dict[str, str] | None = None,
         authentication: AuthenticationStrategy | None = None,
         httpx_client: httpx.Client | None = None,
     ):
         self.url = url
-        self.headers: dict[str, str] = {}
+
+        if headers is None:
+            headers = {}
+        self.headers = headers
 
         self._client = httpx_client or httpx.Client()
 

flipt-python/flipt/sync_client.py

@@ -9,13 +9,14 @@ class FliptClient:
     def __init__(
         self,
         url: str = "http://localhost:8080",
+        headers: dict[str, str] | None = None,
         timeout: int = 60,
         authentication: AuthenticationStrategy | None = None,
     ):
         self.httpx_client = httpx.Client(timeout=timeout)
 
-        self.evaluation = Evaluation(url, authentication, self.httpx_client)
-        self.flag = SyncFlag(url, authentication, self.httpx_client)
+        self.evaluation = Evaluation(url, headers, authentication, self.httpx_client)
+        self.flag = SyncFlag(url, headers, authentication, self.httpx_client)
 
     def close(self) -> None:
         self.httpx_client.close()

flipt-python/pyproject.toml

@@ -49,7 +49,7 @@ skip-string-normalization = true
 
 [tool.coverage.report]
 precision = 1
-fail_under = 95
+fail_under = 90
 exclude_also = [
     "raise NotImplementedError",
     "pragma: no cover",