gofeatureflag-python-provider 0.2.1__tar.gz → 0.4.0__tar.gz

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: gofeatureflag-python-provider
-Version: 0.2.1
+Version: 0.4.0
 Summary: GO Feature Flag provider for OpenFeature
-Home-page: https://gofeatureflag.org
 License: Apache-2.0
 Keywords: feature flags,feature toggles,go-feature-flag,gofeatureflag,openfeature,open-feature
 Author: Thomas Poignant
@@ -13,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: asyncio (>=3.4.3,<4.0.0)
@@ -24,6 +24,7 @@ Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
 Requires-Dist: websocket-client (>=1.6.4,<2.0.0)
 Project-URL: Bug Tracker, https://github.com/thomaspoignant/go-feature-flag/issues
 Project-URL: Documentation, https://github.com/thomaspoignant/go-feature-flag/tree/main/openfeature/providers/python-provider
+Project-URL: Homepage, https://gofeatureflag.org
 Project-URL: Repository, https://github.com/thomaspoignant/go-feature-flag
 Project-URL: Source Code, https://github.com/thomaspoignant/go-feature-flag/tree/main/openfeature/providers/python-provider
 Description-Content-Type: text/markdown

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/gofeatureflag_python_provider/data_collector_hook.py

@@ -1,19 +1,17 @@
 import datetime
 import threading
 import time
-from http import HTTPStatus
-from typing import Optional
-from urllib.parse import urljoin
-
 import urllib3
-from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
-from openfeature.hook import Hook, HookContext
-
 from gofeatureflag_python_provider.options import GoFeatureFlagOptions
 from gofeatureflag_python_provider.request_data_collector import (
     FeatureEvent,
     RequestDataCollector,
 )
+from http import HTTPStatus
+from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
+from openfeature.hook import Hook, HookContext
+from typing import Optional
+from urllib.parse import urljoin
 
 default_targeting_key = "undefined-targetingKey"
 
@@ -31,6 +29,8 @@ class DataCollectorHook(Hook):
     _http_client: urllib3.PoolManager = None
     # _data_event_queue is the list of data to collect
     _event_queue: list[FeatureEvent] = []
+    # _exporter_metadata is the metadata we send to the GO Feature Flag relay proxy when we report the evaluation data usage.
+    _exporter_metadata: dict = {}
 
     def __init__(self, options: GoFeatureFlagOptions, http_client: urllib3.PoolManager):
         self._http_client = http_client
@@ -39,6 +39,9 @@ class DataCollectorHook(Hook):
         self._data_collector_endpoint = urljoin(
             str(self._options.endpoint), "/v1/data/collector"
         )
+        self._exporter_metadata = options.exporter_metadata
+        self._exporter_metadata["provider"] = "python"
+        self._exporter_metadata["openfeature"] = True
 
     def after(
         self, hook_context: HookContext, details: FlagEvaluationDetails, hints: dict
@@ -106,13 +109,17 @@ class DataCollectorHook(Hook):
         if len(self._event_queue) > 0:
             try:
                 goff_request = RequestDataCollector(
-                    meta={"provider": "open-feature-python-sdk"},
+                    meta=self._exporter_metadata,
                     events=self._event_queue,
                 )
+                headers = {"Content-Type": "application/json"}
+                if self._options.api_key:
+                    headers["Authorization"] = "Bearer {}".format(self._options.api_key)
+
                 response = self._http_client.request(
                     method="POST",
                     url=urljoin(str(self._options.endpoint), "/v1/data/collector"),
-                    headers={"Content-Type": "application/json"},
+                    headers=headers,
                     body=goff_request.model_dump_json(),
                 )
 

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/gofeatureflag_python_provider/options.py

@@ -45,3 +45,15 @@ class GoFeatureFlagOptions(BaseModel):
     # config changes.
     # default: false
     disable_cache_invalidation: typing.Optional[bool] = False
+
+    # api_key (optional) If the relay proxy is configured to authenticate the requests, you should provide
+    # an API Key to the provider. Please ask the administrator of the relay proxy to provide an API Key.
+    # Default: None
+    api_key: typing.Optional[str] = None
+
+    # ExporterMetadata (optional) is the metadata we send to the GO Feature Flag relay proxy when we report the
+    # evaluation data usage.
+    #
+    # ‼️Important: If you are using a GO Feature Flag relay proxy before version v1.41.0, the information of this
+    # field will not be added to your feature events.
+    exporter_metadata: typing.Optional[dict] = {}

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/gofeatureflag_python_provider/provider.py

@@ -188,13 +188,18 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
                 response_body = self._cache[evaluation_context_hash]
                 is_from_cache = True
             else:
+                headers = {"Content-Type": "application/json"}
+                if self.options.api_key is not None:
+                    headers["Authorization"] = "Bearer {}".format(self.options.api_key)
+                url = "{}{}".format(
+                    str(self.options.endpoint).rstrip("/"),
+                    "/v1/feature/{}/eval".format(flag_key),
+                )
+
                 response = self._http_client.request(
                     method="POST",
-                    url=urljoin(
-                        str(self.options.endpoint),
-                        "/v1/feature/{}/eval".format(flag_key),
-                    ),
-                    headers={"Content-Type": "application/json"},
+                    url=url,
+                    headers=headers,
                     body=goff_request.model_dump_json(),
                 )
 
@@ -261,10 +266,15 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         _build_websocket_uri is a helper to build the websocket uri to connect to the GO Feature Flag relay proxy.
         :return: a string representing the websocket uri
         """
-        http_uri = urljoin(
-            str(self.options.endpoint),
-            "/ws/v1/flag/change",
+        url = "/ws/v1/flag/change"
+        if self.options.api_key is not None:
+            url = "{}?apiKey={}".format(url, self.options.api_key)
+
+        http_uri = "{}{}".format(
+            str(self.options.endpoint).rstrip("/"),
+            url,
         )
+
         http_uri = http_uri.replace("http", "ws")
         http_uri = http_uri.replace("https", "wss")
         return http_uri

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/gofeatureflag_python_provider/request_data_collector.py

@@ -1,8 +1,6 @@
-from typing import Optional, Any
-
-from pydantic import Field, SkipValidation
-
 from gofeatureflag_python_provider.options import BaseModel
+from pydantic import Field, SkipValidation
+from typing import Optional, Any, Union
 
 
 class FeatureEvent(BaseModel):
@@ -47,7 +45,7 @@ class FeatureEvent(BaseModel):
 
 class RequestDataCollector(BaseModel):
     # Meta are the extra information added to identify who is calling the endpoint.
-    meta: Optional[dict[str, str]] = None
+    meta: Optional[dict[str, Union[str, int, float, bool]]] = None
 
     # Events is the list of the event we send in the payload
     events: list[FeatureEvent] = []

{gofeatureflag_python_provider-0.2.1 → gofeatureflag_python_provider-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gofeatureflag-python-provider"
-version = "0.2.1"
+version = "0.4.0"
 description = "GO Feature Flag provider for OpenFeature"
 license = "Apache-2.0"
 authors = [ "Thomas Poignant" ]