devcycle-python-server-sdk 3.9.0__tar.gz → 3.11.0__tar.gz

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/PKG-INFO

@@ -1,24 +1,25 @@
 Metadata-Version: 2.2
 Name: devcycle-python-server-sdk
-Version: 3.9.0
+Version: 3.11.0
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author-email: 
 Keywords: DevCycle
+Requires-Python: >=3.9
 License-File: LICENSE
 Requires-Dist: setuptools>=21.0.0
 Requires-Dist: urllib3>=1.15.1
-Requires-Dist: requests~=2.31
-Requires-Dist: wasmtime==23.0.0
+Requires-Dist: requests>=2.32
+Requires-Dist: wasmtime~=30.0.0
 Requires-Dist: protobuf>=4.23.3
-Requires-Dist: openfeature-sdk>=0.7.0
-Requires-Dist: launchdarkly-eventsource>=1.2.0
-Requires-Dist: responses~=0.23.1
-Requires-Dist: dataclasses~=0.6
+Requires-Dist: openfeature-sdk>=0.8.0
+Requires-Dist: launchdarkly-eventsource>=1.2.1
+Requires-Dist: responses>=0.23.1
 Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: requires-dist
+Dynamic: requires-python
 Dynamic: summary
 
     The DevCycle Python SDK used for feature management.

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/README.md

@@ -4,15 +4,16 @@ The DevCycle Python SDK used for feature management.
 
 This SDK allows your application to interface with the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/devcycle).
 
-## Requirements.
+## Requirements
 
-* Python 3.8+
+* Python 3.9+
 
 ## Installation
 
 ```sh
 pip install devcycle-python-server-sdk
 ```
+
 (you may need to run `pip` with root permission: `sudo pip install devcycle-python-server-sdk`)
 
 ## Getting Started
@@ -65,38 +66,47 @@ When developing the SDK it is recommended that you have both a 3.8 and 3.12 pyth
 ### Dependencies
 
 To set up dependencies for local development, run:
-```
+
+```bash
 pip install -r requirements.test.txt
 ```
 
 To run the example app against the local version of the API for testing and development, run:
-```sh
+
+```bash
 pip install --editable .
 ```
-from the top level of the repo (same level as setup.py). Then run the example app as normal.
 
+from the top level of the repo (same level as setup.py). Then run the example app as normal:
+
+```bash
+python example/local_bucketing_client_example.py
+```
 
 ### Linting & Formatting
 
 Linting checks on PRs are run using [ruff](https://github.com/charliermarsh/ruff), and are configured using `.ruff.toml`. To run the linter locally, run this command from the top level of the repo:
-```
+
+```bash
 ruff check .
 ```
 
 Ruff can automatically fix simple linting errors (the ones marked with `[*]`). To do so, run:
-```
+
+```bash
 ruff check . --fix
 ```
 
 Formatting checks on PRs are done using [black](https://github.com/psf/black). To run the formatter locally, run this command from the top level of the repo:
 
-```
+```bash
 black .
 ```
 
 ### Unit Tests
 
 To run the unit tests, run:
+
 ```bash
 pytest
 ```
@@ -104,6 +114,7 @@ pytest
 ### Benchmarks
 
 To run the benchmarks, run:
+
 ```bash
 pytest --benchmark-only
 ```
@@ -116,4 +127,4 @@ To generate the protobuf source files run the following from the root of the pro
 protoc --proto_path=./protobuf/ --python_out=devcycle_python_sdk/protobuf --pyi_out=devcycle_python_sdk/protobuf variableForUserParams.proto
 ```
 
-This will rebuild the `variableForUserParams_pb2.py` file. DO NOT edit this file directly.
+This will rebuild the `variableForUserParams_pb2.py` file. DO NOT edit this file directly.

devcycle_python_server_sdk-3.11.0/devcycle_python_sdk/VERSION.txt

@@ -0,0 +1 @@
+3.11.0

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/cloud_client.py

@@ -182,6 +182,13 @@ class DevCycleCloudClient(AbstractDevCycleClient):
         except Exception as e:
             logger.error(f"DevCycle: Error tracking event: {e}")
 
+    def close(self) -> None:
+        """
+        Closes the client and releases any resources held by it.
+        """
+        # Cloud client doesn't need to release any resources
+        logger.debug("DevCycle: Cloud client closed")
+
 
 def _validate_sdk_key(sdk_key: str) -> None:
     if sdk_key is None or len(sdk_key) == 0:

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/devcycle_client.py

@@ -38,3 +38,10 @@ class AbstractDevCycleClient:
     @abstractmethod
     def get_sdk_platform(self) -> str:
         pass
+
+    @abstractmethod
+    def close(self) -> None:
+        """
+        Closes the client and releases any resources held by it.
+        """
+        pass

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/local_client.py

@@ -2,7 +2,7 @@ import json
 import logging
 import uuid
 from numbers import Real
-from typing import Any, Dict, Union
+from typing import Any, Dict, Union, Optional
 
 from devcycle_python_sdk import DevCycleLocalOptions, AbstractDevCycleClient
 from devcycle_python_sdk.api.local_bucketing import LocalBucketing
@@ -50,12 +50,21 @@ class DevCycleLocalClient(AbstractDevCycleClient):
             sdk_key, self.client_uuid, self.options, self.local_bucketing
         )
 
-        self._openfeature_provider = DevCycleProvider(self)
+        self._openfeature_provider: Optional[DevCycleProvider] = None
 
     def get_sdk_platform(self) -> str:
         return "Local"
 
     def get_openfeature_provider(self) -> AbstractProvider:
+        if self._openfeature_provider is None:
+            self._openfeature_provider = DevCycleProvider(self)
+
+            # Update platform data for OpenFeature
+            self._platform_data.sdkPlatform = "python-of"
+            self.local_bucketing.set_platform_data(
+                json.dumps(self._platform_data.to_json())
+            )
+
         return self._openfeature_provider
 
     def is_initialized(self) -> bool:

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/models/event.py

@@ -18,7 +18,7 @@ class EventType:
 class DevCycleEvent:
     type: Optional[str] = None
     target: Optional[str] = None
-    date: datetime = field(default_factory=lambda: datetime.utcnow())
+    date: datetime = field(default_factory=lambda: datetime.now(timezone.utc))
     value: Optional[int] = None
     metaData: Optional[Dict[str, str]] = None
 

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/models/platform_data.py

@@ -1,6 +1,7 @@
 # ruff: noqa: N815
 import platform
 import socket
+from typing import Optional
 from dataclasses import dataclass
 from devcycle_python_sdk.util.version import sdk_version
 
@@ -13,6 +14,7 @@ class PlatformData:
     deviceModel: str
     platform: str
     hostname: str
+    sdkPlatform: Optional[str] = None
 
     def to_json(self):
         return {

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/models/user.py

@@ -16,7 +16,7 @@ class DevCycleUser:
     appVersion: Optional[str] = None
     appBuild: Optional[str] = None
     customData: Optional[Dict[str, Any]] = None
-    createdDate: datetime = field(default_factory=lambda: datetime.utcnow())
+    createdDate: datetime = field(default_factory=lambda: datetime.now(timezone.utc))
     privateCustomData: Optional[Dict[str, Any]] = None
     lastSeenDate: Optional[datetime] = None
     platform: Optional[str] = None
@@ -24,6 +24,7 @@ class DevCycleUser:
     deviceModel: Optional[str] = None
     sdkType: Optional[str] = None
     sdkVersion: Optional[str] = None
+    sdkPlatform: Optional[str] = None
 
     def to_json(self):
         json_dict = {
@@ -50,7 +51,7 @@ class DevCycleUser:
                 data["createdDate"].replace("Z", "+00:00")
             )
         else:
-            created_date = datetime.utcnow()
+            created_date = datetime.now(timezone.utc)
 
         last_seen_date = None
         if "lastSeenDate" in data:
@@ -75,6 +76,7 @@ class DevCycleUser:
             deviceModel=data.get("deviceModel"),
             sdkType=data.get("sdkType"),
             sdkVersion=data.get("sdkVersion"),
+            sdkPlatform=data.get("sdkPlatform"),
         )
 
     @staticmethod
@@ -156,4 +158,5 @@ class DevCycleUser:
         if private_custom_data:
             user.privateCustomData = private_custom_data
 
+        user.sdkPlatform = "python-of"
         return user

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_sdk/open_feature_provider/provider.py

@@ -1,4 +1,5 @@
 import logging
+import time
 
 from typing import Any, Optional, Union, List
 
@@ -6,11 +7,16 @@ from devcycle_python_sdk import AbstractDevCycleClient
 from devcycle_python_sdk.models.user import DevCycleUser
 
 from openfeature.provider import AbstractProvider
+from openfeature.provider.metadata import Metadata
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.flag_evaluation import FlagResolutionDetails, Reason
-from openfeature.exception import ErrorCode, InvalidContextError, TypeMismatchError
+from openfeature.exception import (
+    ErrorCode,
+    InvalidContextError,
+    TypeMismatchError,
+    GeneralError,
+)
 from openfeature.hook import Hook
-from openfeature.provider.metadata import Metadata
 
 logger = logging.getLogger(__name__)
 
@@ -26,6 +32,24 @@ class DevCycleProvider(AbstractProvider):
         self.client = devcycle_client
         self.meta_data = Metadata(name=f"DevCycle {self.client.get_sdk_platform()}")
 
+    def initialize(self, evaluation_context: EvaluationContext) -> None:
+        timeout = 2
+        start_time = time.time()
+
+        # Wait for the client to be initialized or timeout
+        while not self.client.is_initialized():
+            if time.time() - start_time > timeout:
+                raise GeneralError(
+                    f"DevCycleProvider initialization timed out after {timeout} seconds"
+                )
+            time.sleep(0.1)  # Sleep briefly to avoid busy waiting
+
+        if self.client.is_initialized():
+            logger.debug("DevCycleProvider initialized successfully")
+
+    def shutdown(self) -> None:
+        self.client.close()
+
     def get_metadata(self) -> Metadata:
         return self.meta_data
 

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/devcycle_python_server_sdk.egg-info/PKG-INFO

@@ -1,24 +1,25 @@
 Metadata-Version: 2.2
 Name: devcycle-python-server-sdk
-Version: 3.9.0
+Version: 3.11.0
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author-email: 
 Keywords: DevCycle
+Requires-Python: >=3.9
 License-File: LICENSE
 Requires-Dist: setuptools>=21.0.0
 Requires-Dist: urllib3>=1.15.1
-Requires-Dist: requests~=2.31
-Requires-Dist: wasmtime==23.0.0
+Requires-Dist: requests>=2.32
+Requires-Dist: wasmtime~=30.0.0
 Requires-Dist: protobuf>=4.23.3
-Requires-Dist: openfeature-sdk>=0.7.0
-Requires-Dist: launchdarkly-eventsource>=1.2.0
-Requires-Dist: responses~=0.23.1
-Requires-Dist: dataclasses~=0.6
+Requires-Dist: openfeature-sdk>=0.8.0
+Requires-Dist: launchdarkly-eventsource>=1.2.1
+Requires-Dist: responses>=0.23.1
 Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: requires-dist
+Dynamic: requires-python
 Dynamic: summary
 
     The DevCycle Python SDK used for feature management.

devcycle_python_server_sdk-3.11.0/devcycle_python_server_sdk.egg-info/requires.txt

@@ -0,0 +1,8 @@
+setuptools>=21.0.0
+urllib3>=1.15.1
+requests>=2.32
+wasmtime~=30.0.0
+protobuf>=4.23.3
+openfeature-sdk>=0.8.0
+launchdarkly-eventsource>=1.2.1
+responses>=0.23.1

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/pyproject.toml

@@ -5,12 +5,12 @@ addopts = "--benchmark-skip --showlocals"
 
 # black options
 [tool.black]
-target-version = ['py37']
+target-version = ['py39']
 extend-exclude = '_pb2\.pyi?$'
 
 # mypy options
 [tool.mypy]
-python_version = "3.8"
+python_version = "3.9"
 exclude = "django-app"
 
 # See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-library-stubs-or-py-typed-marker
@@ -43,20 +43,17 @@ ignore_missing_imports = true
 [tool.ruff]
 # https://beta.ruff.rs/docs/rules/
 select = [
-	"F", # PyFlakes
-	"E", # pycodestyle error
-	"W", # pycodestyle warning
-	"N", # pep8-naming
-	"T20", # flake8-print
+	"F",      # PyFlakes
+	"E",      # pycodestyle error
+	"W",      # pycodestyle warning
+	"N",      # pep8-naming
+	"T20",    # flake8-print
 	"RUF100", # ensure noqa comments actually match an error
 ]
 ignore = [
 	"E501", # line too long
 ]
-exclude = [
-  "variableForUserParams_pb2.pyi"
-]
+exclude = ["variableForUserParams_pb2.pyi"]
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401"]
 "variableForUserParams_pb2.py" = ["F821", "N999", "E712"]
-

{devcycle_python_server_sdk-3.9.0 → devcycle_python_server_sdk-3.11.0}/setup.py

@@ -24,6 +24,7 @@ setup(
     url="https://github.com/devcycleHQ/python-server-sdk",
     keywords=["DevCycle"],
     install_requires=REQUIRES,
+    python_requires=">=3.9",
     packages=find_packages(),
     package_data={
         "": ["VERSION.txt"],

devcycle_python_server_sdk-3.9.0/devcycle_python_sdk/VERSION.txt

@@ -1 +0,0 @@
-3.9.0

devcycle_python_server_sdk-3.9.0/devcycle_python_server_sdk.egg-info/requires.txt

@@ -1,9 +0,0 @@
-setuptools>=21.0.0
-urllib3>=1.15.1
-requests~=2.31
-wasmtime==23.0.0
-protobuf>=4.23.3
-openfeature-sdk>=0.7.0
-launchdarkly-eventsource>=1.2.0
-responses~=0.23.1
-dataclasses~=0.6