flagsmith 3.9.1__tar.gz → 3.10.0__tar.gz

{flagsmith-3.9.1 → flagsmith-3.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flagsmith
-Version: 3.9.1
+Version: 3.10.0
 Summary: Flagsmith Python SDK
 License: BSD3
 Keywords: feature,flag,flagsmith,remote,config
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: flagsmith-flag-engine (>=5.1.0,<6.0.0)
+Requires-Dist: flagsmith-flag-engine (>=6.0.2,<7.0.0)
 Requires-Dist: pydantic (>=2,<3)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: requests-futures (>=1.0.1,<2.0.0)
@@ -22,8 +22,6 @@ Requires-Dist: sseclient-py (>=1.8.0,<2.0.0)
 Project-URL: Documentation, https://docs.flagsmith.com
 Description-Content-Type: text/markdown
 
-<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
-
 # Flagsmith Python SDK
 
 > Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and

{flagsmith-3.9.1 → flagsmith-3.10.0}/README.md

@@ -1,5 +1,3 @@
-<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
-
 # Flagsmith Python SDK
 
 > Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and

flagsmith-3.10.0/flagsmith/__init__.py

@@ -0,0 +1,5 @@
+from flagsmith import webhooks
+from flagsmith.flagsmith import Flagsmith
+from flagsmith.version import __version__
+
+__all__ = ("Flagsmith", "webhooks", "__version__")

{flagsmith-3.9.1 → flagsmith-3.10.0}/flagsmith/flagsmith.py

@@ -1,4 +1,5 @@
 import logging
+import sys
 import typing
 from datetime import timezone
 
@@ -11,6 +12,7 @@ from flag_engine.identities.traits.models import TraitModel
 from flag_engine.identities.traits.types import TraitValue
 from flag_engine.segments.evaluator import get_identity_segments
 from requests.adapters import HTTPAdapter
+from requests.utils import default_user_agent
 from urllib3 import Retry
 
 from flagsmith.analytics import AnalyticsProcessor
@@ -19,13 +21,24 @@ from flagsmith.models import DefaultFlag, Flags, Segment
 from flagsmith.offline_handlers import BaseOfflineHandler
 from flagsmith.polling_manager import EnvironmentDataPollingManager
 from flagsmith.streaming_manager import EventStreamManager, StreamEvent
-from flagsmith.types import JsonType, TraitConfig, TraitMapping
+from flagsmith.types import (
+    ApplicationMetadata,
+    JsonType,
+    TraitConfig,
+    TraitMapping,
+)
 from flagsmith.utils.identities import generate_identity_data
+from flagsmith.version import __version__
 
 logger = logging.getLogger(__name__)
 
 DEFAULT_API_URL = "https://edge.api.flagsmith.com/api/v1/"
 DEFAULT_REALTIME_API_URL = "https://realtime.flagsmith.com/"
+DEFAULT_USER_AGENT = (
+    f"flagsmith-python-client/{__version__} "
+    + default_user_agent()
+    + f" python/{sys.version_info.major}.{sys.version_info.minor}"
+)
 
 
 class Flagsmith:
@@ -61,6 +74,7 @@ class Flagsmith:
         offline_mode: bool = False,
         offline_handler: typing.Optional[BaseOfflineHandler] = None,
         enable_realtime_updates: bool = False,
+        application_metadata: typing.Optional[ApplicationMetadata] = None,
     ):
         """
         :param environment_key: The environment key obtained from Flagsmith interface.
@@ -88,6 +102,7 @@ class Flagsmith:
             document from another source when in offline_mode. Works in place of
             default_flag_handler if offline_mode is not set and using remote evaluation.
         :param enable_realtime_updates: Use real-time functionality via SSE as opposed to polling the API
+        :param application_metadata: Optional metadata about the client application.
         """
 
         self.offline_mode = offline_mode
@@ -122,7 +137,11 @@ class Flagsmith:
 
             self.session = requests.Session()
             self.session.headers.update(
-                **{"X-Environment-Key": environment_key}, **(custom_headers or {})
+                self._get_headers(
+                    environment_key=environment_key,
+                    application_metadata=application_metadata,
+                    custom_headers=custom_headers,
+                )
             )
             self.session.proxies.update(proxies or {})
             retries = retries or Retry(total=3, backoff_factor=0.1)
@@ -261,7 +280,9 @@ class Flagsmith:
 
         traits = traits or {}
         identity_model = self._get_identity_model(identifier, **traits)
-        segment_models = get_identity_segments(self._environment, identity_model)
+        segment_models = get_identity_segments(
+            environment=self._environment, identity=identity_model
+        )
         return [Segment(id=sm.id, name=sm.name) for sm in segment_models]
 
     def update_environment(self) -> None:
@@ -275,6 +296,24 @@ class Flagsmith:
                     identity.identifier: identity for identity in overrides
                 }
 
+    def _get_headers(
+        self,
+        environment_key: str,
+        application_metadata: typing.Optional[ApplicationMetadata],
+        custom_headers: typing.Optional[typing.Dict[str, typing.Any]],
+    ) -> typing.Dict[str, str]:
+        headers = {
+            "X-Environment-Key": environment_key,
+            "User-Agent": DEFAULT_USER_AGENT,
+        }
+        if application_metadata:
+            if name := application_metadata.get("name"):
+                headers["Flagsmith-Application-Name"] = name
+            if version := application_metadata.get("version"):
+                headers["Flagsmith-Application-Version"] = version
+        headers.update(custom_headers or {})
+        return headers
+
     def _get_environment_from_api(self) -> EnvironmentModel:
         environment_data = self._get_json_response(self.environment_url, method="GET")
         return EnvironmentModel.model_validate(environment_data)

{flagsmith-3.9.1 → flagsmith-3.10.0}/flagsmith/types.py

@@ -1,7 +1,7 @@
 import typing
 
 from flag_engine.identities.traits.types import TraitValue
-from typing_extensions import TypeAlias
+from typing_extensions import NotRequired, TypeAlias
 
 _JsonScalarType: TypeAlias = typing.Union[
     int,
@@ -23,3 +23,8 @@ class TraitConfig(typing.TypedDict):
 
 
 TraitMapping: TypeAlias = typing.Mapping[str, typing.Union[TraitValue, TraitConfig]]
+
+
+class ApplicationMetadata(typing.TypedDict):
+    name: NotRequired[str]
+    version: NotRequired[str]

flagsmith-3.10.0/flagsmith/version.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("flagsmith")

{flagsmith-3.9.1 → flagsmith-3.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flagsmith"
-version = "3.9.1"
+version = "3.10.0"
 description = "Flagsmith Python SDK"
 authors = ["Flagsmith <support@flagsmith.com>"]
 license = "BSD3"
@@ -13,7 +13,7 @@ packages = [{ include = "flagsmith" }]
 python = ">=3.8.1,<4"
 requests = "^2.32.3"
 requests-futures = "^1.0.1"
-flagsmith-flag-engine = "^5.1.0"
+flagsmith-flag-engine = "^6.0.2"
 sseclient-py = "^1.8.0"
 pydantic = "^2"
 
@@ -21,10 +21,11 @@ pydantic = "^2"
 optional = true
 
 [tool.poetry.group.dev.dependencies]
+mypy = { version = "^1.16.1", python = ">=3.9,<4" }
 pytest = "^7.4.0"
 pytest-cov = "^4.1.0"
 pytest-mock = "^3.6.1"
-pre-commit = "^2.17.0"
+pre-commit = { version = "^4.2.0", python = ">=3.9,<4" }
 responses = "^0.24.1"
 types-requests = "^2.32"
 

flagsmith-3.9.1/flagsmith/__init__.py

@@ -1,4 +0,0 @@
-from . import webhooks
-from .flagsmith import Flagsmith
-
-__all__ = ("Flagsmith", "webhooks")