clarity-api-sdk-python 0.1.6__tar.gz → 0.1.9__tar.gz

clarity_api_sdk_python-0.1.9/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: clarity-api-sdk-python
+Version: 0.1.9
+Summary: A Python SDK to connect to the CTI Clarity API server.
+Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
+Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: brotli
+Requires-Dist: h2
+Requires-Dist: httpx_auth>=0.23.1
+Requires-Dist: httpx-retries>=0.4.5
+Requires-Dist: structlog
+Provides-Extra: brotli
+Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
+Provides-Extra: http2
+Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
+
+# Clarity API SDK for Python
+
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
+[![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
+![python](https://img.shields.io/badge/python-3.11%2B-blue)
+
+A Python SDK for connecting to the CTI API server, with structured logging included.
+
+## Installation
+
+```bash
+pip install clarity-api-sdk-python
+```
+
+## Logging
+
+Logging support is built with [structlog](https://pypi.org/project/structlog/).
+
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
+
+```python
+"""Example"""
+
+import logging
+
+from cti.logger import initialize_logger, get_logger, ExternalLoggerConfig
+
+initialize_logger(
+    external_logger_configurations=[
+        ExternalLoggerConfig(name="urllib3"),
+        ExternalLoggerConfig(name="httpcore"),
+        ExternalLoggerConfig(name="httpx"),
+        ExternalLoggerConfig(name="httpx_auth"),
+        ExternalLoggerConfig(name="httpx_retries"),
+    ],
+    handlers=[logging.FileHandler("app.log")]
+)
+
+logger_a = get_logger("logger_a")
+logger_b = get_logger("logger_b", "WARNING")
+
+# root_logger = logging.getLogger()
+# root_logger.setLevel("DEBUG")
+
+logger_a.info("This is info message from logger_a")
+logger_a.critical("This is critical message from logger_a")
+
+# Dynamically change the log level of logger_a to WARNING
+print("\nChanging logger_a level to WARNING...\n")
+logging.getLogger("logger_a").setLevel(logging.WARNING)
+
+logger_a.info("This info message from logger_a should NOT be visible.")
+logger_a.warning("This is a new warning message from logger_a.")
+
+logger_b.info("This info message from logger_b should NOT be visible.")
+logger_b.warning("This is warning message from logger_b")
+```

clarity_api_sdk_python-0.1.9/README.md

@@ -0,0 +1,57 @@
+# Clarity API SDK for Python
+
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
+[![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
+![python](https://img.shields.io/badge/python-3.11%2B-blue)
+
+A Python SDK for connecting to the CTI API server, with structured logging included.
+
+## Installation
+
+```bash
+pip install clarity-api-sdk-python
+```
+
+## Logging
+
+Logging support is built with [structlog](https://pypi.org/project/structlog/).
+
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
+
+```python
+"""Example"""
+
+import logging
+
+from cti.logger import initialize_logger, get_logger, ExternalLoggerConfig
+
+initialize_logger(
+    external_logger_configurations=[
+        ExternalLoggerConfig(name="urllib3"),
+        ExternalLoggerConfig(name="httpcore"),
+        ExternalLoggerConfig(name="httpx"),
+        ExternalLoggerConfig(name="httpx_auth"),
+        ExternalLoggerConfig(name="httpx_retries"),
+    ],
+    handlers=[logging.FileHandler("app.log")]
+)
+
+logger_a = get_logger("logger_a")
+logger_b = get_logger("logger_b", "WARNING")
+
+# root_logger = logging.getLogger()
+# root_logger.setLevel("DEBUG")
+
+logger_a.info("This is info message from logger_a")
+logger_a.critical("This is critical message from logger_a")
+
+# Dynamically change the log level of logger_a to WARNING
+print("\nChanging logger_a level to WARNING...\n")
+logging.getLogger("logger_a").setLevel(logging.WARNING)
+
+logger_a.info("This info message from logger_a should NOT be visible.")
+logger_a.warning("This is a new warning message from logger_a.")
+
+logger_b.info("This info message from logger_b should NOT be visible.")
+logger_b.warning("This is warning message from logger_b")
+```

{clarity_api_sdk_python-0.1.6 → clarity_api_sdk_python-0.1.9}/pyproject.toml

@@ -5,13 +5,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.1.6"
+version = "0.1.9"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]
 description = "A Python SDK to connect to the CTI Clarity API server."
 readme = "README.md"
-requires-python = ">=3.12"
+requires-python = ">=3.11"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",

clarity_api_sdk_python-0.1.9/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: clarity-api-sdk-python
+Version: 0.1.9
+Summary: A Python SDK to connect to the CTI Clarity API server.
+Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
+Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: brotli
+Requires-Dist: h2
+Requires-Dist: httpx_auth>=0.23.1
+Requires-Dist: httpx-retries>=0.4.5
+Requires-Dist: structlog
+Provides-Extra: brotli
+Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
+Provides-Extra: http2
+Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
+
+# Clarity API SDK for Python
+
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
+[![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
+![python](https://img.shields.io/badge/python-3.11%2B-blue)
+
+A Python SDK for connecting to the CTI API server, with structured logging included.
+
+## Installation
+
+```bash
+pip install clarity-api-sdk-python
+```
+
+## Logging
+
+Logging support is built with [structlog](https://pypi.org/project/structlog/).
+
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
+
+```python
+"""Example"""
+
+import logging
+
+from cti.logger import initialize_logger, get_logger, ExternalLoggerConfig
+
+initialize_logger(
+    external_logger_configurations=[
+        ExternalLoggerConfig(name="urllib3"),
+        ExternalLoggerConfig(name="httpcore"),
+        ExternalLoggerConfig(name="httpx"),
+        ExternalLoggerConfig(name="httpx_auth"),
+        ExternalLoggerConfig(name="httpx_retries"),
+    ],
+    handlers=[logging.FileHandler("app.log")]
+)
+
+logger_a = get_logger("logger_a")
+logger_b = get_logger("logger_b", "WARNING")
+
+# root_logger = logging.getLogger()
+# root_logger.setLevel("DEBUG")
+
+logger_a.info("This is info message from logger_a")
+logger_a.critical("This is critical message from logger_a")
+
+# Dynamically change the log level of logger_a to WARNING
+print("\nChanging logger_a level to WARNING...\n")
+logging.getLogger("logger_a").setLevel(logging.WARNING)
+
+logger_a.info("This info message from logger_a should NOT be visible.")
+logger_a.warning("This is a new warning message from logger_a.")
+
+logger_b.info("This info message from logger_b should NOT be visible.")
+logger_b.warning("This is warning message from logger_b")
+```

{clarity_api_sdk_python-0.1.6 → clarity_api_sdk_python-0.1.9}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -5,6 +5,8 @@ src/clarity_api_sdk_python.egg-info/SOURCES.txt
 src/clarity_api_sdk_python.egg-info/dependency_links.txt
 src/clarity_api_sdk_python.egg-info/requires.txt
 src/clarity_api_sdk_python.egg-info/top_level.txt
+src/cti/__init__.py
+src/cti/main.py
 src/cti/api/__init__.py
 src/cti/api/client.py
 src/cti/logger/__init__.py

{clarity_api_sdk_python-0.1.6 → clarity_api_sdk_python-0.1.9}/src/cti/logger/logger.py

@@ -3,6 +3,7 @@
 from collections import OrderedDict
 from dataclasses import dataclass
 import logging
+import os
 import socket
 import sys
 import urllib.error
@@ -32,16 +33,25 @@ class ExternalLoggerConfig:
         self.propagate = propagate
 
 
-def get_logger(name: str) -> logging.Logger:
+def get_logger(
+    name: str, level: int | str | None = None
+) -> structlog.stdlib.BoundLogger:
     """Creates a structlog logger with the specified name.
 
     Args:
         name (str): The logger name.
+        level (int | str | None, optional): The logging level for this logger.
+            If None, the root logger's level is used. Defaults to None.
 
     Returns:
-        logging.Logger: The structlog logger.
+        structlog.stdlib.BoundLogger: The structlog logger.
     """
-    return structlog.get_logger(name)
+    logger = structlog.get_logger(name)
+    if level:
+        # To set the level, we need to get the actual standard library logger instance.
+        stdlib_logger = logging.getLogger(name)
+        stdlib_logger.setLevel(level)
+    return logger
 
 
 def _flatten_extra_processor(_, __, event_dict):
@@ -168,6 +178,7 @@ def _secret_redaction_processor(_, __, event_dict):
 def initialize_logger(
     initial_context: dict | None = None,
     external_logger_configurations: list[ExternalLoggerConfig] | None = None,
+    handlers: list[logging.Handler] | None = None,
 ) -> None:
     """Configures logging for the application using structlog.
 
@@ -194,15 +205,24 @@ def initialize_logger(
             bind to the context at the start of the application. These values
             will be included in every log message. Defaults to None.
         external_logger_configurations (list[ExternalLoggerConfig], optional): A list of configuration
+        handlers (list[logging.Handler], optional): A list of handlers to send log records to.
     """
     # Configure standard logging to be the sink for structlog.
     # The format="%(message)s" is important because structlog will format the log record
     # into a JSON string and pass it as the 'message'.
-    logging.basicConfig(
-        level=_level(),
-        format="%(message)s",
-        stream=sys.stdout,
-    )
+    formatter = logging.Formatter("%(message)s")
+
+    # Create a handler for stdout
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    stdout_handler.setFormatter(formatter)
+
+    # Get the root logger and add handlers
+    root_logger = logging.getLogger()
+    root_logger.addHandler(stdout_handler)
+    for handler in handlers or []:
+        handler.setFormatter(formatter)
+        root_logger.addHandler(handler)
+    root_logger.setLevel(_level())
 
     # configure external loggers
     if external_logger_configurations:
@@ -260,15 +280,13 @@ def initialize_logger(
         structlog.contextvars.bind_contextvars(**static_context)
 
 
-def _level():
+def _level() -> str:
     """Get the log level for the logger.
 
-    Set optional environment variable.
-
-        - MANUAL only logs ERROR
-        - PRODUCTION - turns off debug
+    The log level is determined by the `LOG_LEVEL` environment variable.
+    If the environment variable is not set, it defaults to "ERROR".
 
     Returns:
-        str: log level
+        str: The log level as a string (e.g., "DEBUG", "INFO", "ERROR").
     """
-    return "DEBUG"
+    return os.getenv("LOG_LEVEL", "INFO").upper()

clarity_api_sdk_python-0.1.9/src/cti/main.py

@@ -0,0 +1,33 @@
+"""Example"""
+
+import logging
+
+from cti.logger import initialize_logger, get_logger, ExternalLoggerConfig
+
+initialize_logger(
+    external_logger_configurations=[
+        ExternalLoggerConfig(name="urllib3"),
+        ExternalLoggerConfig(name="httpcore"),
+        ExternalLoggerConfig(name="httpx"),
+        ExternalLoggerConfig(name="httpx_auth"),
+        ExternalLoggerConfig(name="httpx_retries"),
+    ]
+)
+
+logger_a = get_logger("logger_a")
+logger_b = get_logger("logger_b", "WARNING")
+
+# root_logger = logging.getLogger()
+# root_logger.setLevel("DEBUG")
+
+logger_a.info("This is info message from logger_a")
+logger_a.critical("This is critical message from logger_a")
+
+# Dynamically change the log level of logger_a to WARNING
+print("\nChanging logger_a level to WARNING...\n")
+logging.getLogger("logger_a").setLevel(logging.WARNING)
+
+logger_a.info("This info message from logger_a should NOT be visible.")
+logger_a.warning("This is a new warning message from logger_a.")
+
+logger_b.warning("This is warning message from logger_b")

clarity_api_sdk_python-0.1.6/PKG-INFO

@@ -1,31 +0,0 @@
-Metadata-Version: 2.4
-Name: clarity-api-sdk-python
-Version: 0.1.6
-Summary: A Python SDK to connect to the CTI Clarity API server.
-Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
-Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: brotli
-Requires-Dist: h2
-Requires-Dist: httpx_auth>=0.23.1
-Requires-Dist: httpx-retries>=0.4.5
-Requires-Dist: structlog
-Provides-Extra: brotli
-Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
-Provides-Extra: http2
-Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
-
-# Clarity API SDK for Python
-
-A Python SDK for connecting to the CTI API server, with structured logging included.
-
-## Installation
-
-```bash
-pip install clarity-api-sdk-python
-```

clarity_api_sdk_python-0.1.6/README.md

@@ -1,9 +0,0 @@
-# Clarity API SDK for Python
-
-A Python SDK for connecting to the CTI API server, with structured logging included.
-
-## Installation
-
-```bash
-pip install clarity-api-sdk-python
-```

clarity_api_sdk_python-0.1.6/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,31 +0,0 @@
-Metadata-Version: 2.4
-Name: clarity-api-sdk-python
-Version: 0.1.6
-Summary: A Python SDK to connect to the CTI Clarity API server.
-Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
-Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: brotli
-Requires-Dist: h2
-Requires-Dist: httpx_auth>=0.23.1
-Requires-Dist: httpx-retries>=0.4.5
-Requires-Dist: structlog
-Provides-Extra: brotli
-Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
-Provides-Extra: http2
-Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
-
-# Clarity API SDK for Python
-
-A Python SDK for connecting to the CTI API server, with structured logging included.
-
-## Installation
-
-```bash
-pip install clarity-api-sdk-python
-```