refactor: support for logger transport(s), update README

Author: Abhi591

CHANGELOG.md

@@ -4,6 +4,68 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2025-04-22
+
+### Added
+
+- Added support to add single `transport` or multiple transport using key `transports`. The transport parameter allows you to implement custom logging behavior by providing your own logging functions.
+
+  ```python
+  from vwo import init
+
+  class CustomTransport:
+    def __init__(self, config):
+        self.level = config.get('level', "ERROR")
+        self.config = config
+
+    def log(self, level, message):
+        # your custom implementation here
+
+  options = {
+      'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key
+      'account_id': '123456', # VWO Account ID
+      'logger' {
+        'transport': CustomTransport({'level': 'INFO'})
+      }
+  }
+
+  vwo_client = init(options)
+  ```
+
+- For multiple transports you can use the `transports` parameter. For example:
+  ```python
+  from vwo import init
+
+  class CustomTransportForInfo:
+      def __init__(self, config):
+          self.level = config.get('level', "INFO")
+          self.config = config
+
+      def log(self, level, message):
+          # your custom implementation here
+
+  class CustomTransportForError:
+      def __init__(self, config):
+          self.level = config.get('level', "ERROR")
+          self.config = config
+
+      def log(self, level, message):
+          # your custom implementation here
+
+  options = {
+      'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key
+      'account_id': '123456', # VWO Account ID
+      'logger' {
+          'transports': [
+              CustomTransportForInfo({'level': 'INFO'}),
+              CustomTransportForError({'level': 'ERROR'})
+          ]
+      }
+  }
+
+  vwo_client = init(options)
+  ```
+
 ## [1.7.0] - 2025-04-11
 
 ### Added

LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Wingify Software Pvt. Ltd.
+   Copyright 2024-2025 Wingify Software Pvt. Ltd.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

NOTICE

@@ -1,4 +1,4 @@
-Copyright 2024 Wingify Software Pvt. Ltd.
+Copyright 2024-2025 Wingify Software Pvt. Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -240,6 +240,24 @@ options = {
 vwo_client = init(options)
 ```
 
+### Integrations
+VWO FME SDKs provide seamless integration with third-party tools like analytics platforms, monitoring services, customer data platforms (CDPs), and messaging systems. This is achieved through a simple yet powerful callback mechanism that receives VWO-specific properties and can forward them to any third-party tool of your choice.
+
+```python
+def callback(properties):
+    # properties will contain all the required VWO specific information
+    print(properties)
+
+options = {
+    'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key
+    'account_id': '12345', # VWO Account ID
+    'integrations': {
+        'callback': callback
+    }
+}
+vwo_client = init(options)
+```
+
 ### Logger
 
 VWO by default logs all `ERROR` level messages to your server console.
@@ -249,6 +267,7 @@ To gain more control over VWO's logging behaviour, you can use the `logger` para
 | ------------- | -------------------------------------- | ------------ | -------- | ----------------- |
 | `level`       | Log level to control verbosity of logs | Yes          | str   | `ERROR`           |
 | `prefix`      | Custom prefix for log messages         | No           | str   | `VWO-SDK`             |
+| `transport`      | Custom logger implementation	         | No           | object   |  See example below           |
 
 #### Example 1: Set log level to control verbosity of logs
 
@@ -277,21 +296,74 @@ options = {
 vwo_client = init(options)
 ```
 
-### Integrations
-VWO FME SDKs provide seamless integration with third-party tools like analytics platforms, monitoring services, customer data platforms (CDPs), and messaging systems. This is achieved through a simple yet powerful callback mechanism that receives VWO-specific properties and can forward them to any third-party tool of your choice.
+#### Example 3: Implement custom transport to handle logs your way
 
+The `transport` parameter allows you to implement custom logging behavior by providing your own logging functions. You can define handlers for different log levels (`debug`, `info`, `warn`, `error`, `trace`) to process log messages according to your needs.
+
+For example, you could:
+
+- Send logs to a third-party logging service
+- Write logs to a file
+- Format log messages differently
+- Filter or transform log messages
+- Route different log levels to different destinations
+
+The transport object should implement handlers for the log levels you want to customize. Each handler receives the log message as a parameter.
+
+For single transport you can use the `transport` parameter. For example:
 ```python
-def callback(properties):
-    # properties will contain all the required VWO specific information
-    print(properties)
+from vwo import init
+
+class CustomTransport:
+    def __init__(self, config):
+        self.level = config.get('level', "ERROR")
+        self.config = config
+
+    def log(self, level, message):
+        # your custom implementation here
 
 options = {
     'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key
-    'account_id': '12345', # VWO Account ID
-    'integrations': {
-        'callback': callback
+    'account_id': '123456', # VWO Account ID
+    'logger' {
+        'transport': CustomTransport({'level': 'INFO'})
     }
 }
+
+vwo_client = init(options)
+```
+
+For multiple transports you can use the `transports` parameter. For example:
+```python
+from vwo import init
+
+class CustomTransportForInfo:
+    def __init__(self, config):
+        self.level = config.get('level', "INFO")
+        self.config = config
+
+    def log(self, level, message):
+        # your custom implementation here
+
+class CustomTransportForError:
+    def __init__(self, config):
+        self.level = config.get('level', "ERROR")
+        self.config = config
+
+    def log(self, level, message):
+        # your custom implementation here
+
+options = {
+    'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key
+    'account_id': '123456', # VWO Account ID
+    'logger' {
+        'transports': [
+            CustomTransportForInfo({'level': 'INFO'}),
+            CustomTransportForError({'level': 'ERROR'})
+        ]
+    }
+}
+
 vwo_client = init(options)
 ```
 
@@ -328,4 +400,4 @@ Our [Code of Conduct](https://github.com/wingify/vwo-fme-python-sdk/blob/master/
 
 [Apache License, Version 2.0](https://github.com/wingify/vwo-fme-python-sdk/blob/master/LICENSE)
 
-Copyright 2024 Wingify Software Pvt. Ltd.
+Copyright 2024-2025 Wingify Software Pvt. Ltd.

scripts/apache_license_check.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

scripts/doc_check.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,7 +29,7 @@ def is_constant_class(Foo):
 
 # Reference taken from https://stackoverflow.com/a/25562415/13268491
 def import_submodules(package, recursive=True):
-    """ Import all submodules of a module, recursively, including subpackages
+    """Import all submodules of a module, recursively, including subpackages
 
     :param package: package (name or actual module)
     :type package: str | module
@@ -60,7 +60,12 @@ def find_non_doc_code(obj):
                     else:
                         find_non_doc_code(value)
                 if not value.__doc__:
-                    print('"' + inspect.getsourcefile(value) + '", line ' + str(inspect.getsourcelines(value)[-1]))
+                    print(
+                        '"'
+                        + inspect.getsourcefile(value)
+                        + '", line '
+                        + str(inspect.getsourcelines(value)[-1])
+                    )
                     is_document_missing = True
         except Exception:
             pass
@@ -78,4 +83,4 @@ def find_non_doc_code(obj):
     is_document_missing = False
     for module in modules:
         is_document_missing |= find_non_doc_code(module)
-    sys.exit(is_document_missing)
+    sys.exit(is_document_missing)

setup.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -57,7 +57,7 @@ def finalize_options(self):
 
     def run(self):
         subprocess.call(
-            'python3 ./scripts/apache_license_check.py vwo/ tests/ setup.py --copyright 2024 Wingify Software Pvt. Ltd."',
+            'python3 ./scripts/apache_license_check.py vwo/ tests/ setup.py --Copyright 2024-2025 Wingify Software Pvt. Ltd."',
             shell=True,
         )
 
@@ -121,7 +121,7 @@ def run(self):
 
 setup(
     name="vwo-fme-python-sdk",
-    version="1.7.0",
+    version="1.8.0",
     description="VWO Feature Management and Experimentation SDK for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",

tests/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
-# limitations under the License.
+# limitations under the License.

tests/data/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
-# limitations under the License.
+# limitations under the License.

tests/data/dummy_test_data_reader.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 # Determine the base directory (the directory containing this script)
 base_dir = os.path.dirname(__file__)
 
+
 def load_settings_json_files(directory_path):
     """
     Load all JSON files from a specified directory into a dictionary.
@@ -30,32 +31,33 @@ def load_settings_json_files(directory_path):
 
     # Iterate through all files in the directory
     for filename in os.listdir(directory_path):
-        if filename.endswith('.json'):
+        if filename.endswith(".json"):
             file_path = os.path.join(directory_path, filename)
             try:
-                with open(file_path, 'r', encoding='utf-8') as file:
+                with open(file_path, "r", encoding="utf-8") as file:
                     json_content = json.load(file)
                     # remove .json from filename
-                    filename = filename.split('.')[0]
+                    filename = filename.split(".")[0]
                     json_files_content[filename] = json_content
             except (json.JSONDecodeError, IOError) as e:
                 print(f"Error reading {filename}: {e}")
 
     return json_files_content
 
+
 def load_test_data_json_file(filename: str) -> Dict[str, str]:
     """
     Loads a JSON file and returns its content as a dictionary.
-    
+
     :param filename: The name of the JSON file to load.
     :return: A dictionary with the contents of the JSON file.
     """
-    filepath = os.path.join(base_dir, 'test_cases', filename)
-    with open(filepath, 'r') as file:
+    filepath = os.path.join(base_dir, "test_cases", filename)
+    with open(filepath, "r") as file:
         return json.load(file)
 
 
 # Load the JSON files
-settings_files = load_settings_json_files(os.path.join(base_dir, 'settings'))
-test_data = load_test_data_json_file('index.json')
-segmentor_dummy_dsl = load_test_data_json_file('dummy_dsl.json')
+settings_files = load_settings_json_files(os.path.join(base_dir, "settings"))
+test_data = load_test_data_json_file("index.json")
+segmentor_dummy_dsl = load_test_data_json_file("dummy_dsl.json")