python-sdk-remote 0.0.145__tar.gz → 0.0.147__tar.gz

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.145
+Version: 0.0.147
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/python_sdk_remote/src/http_response.py

@@ -11,7 +11,7 @@ AUTHORIZATION_KEY = 'authorization'
 AUTHORIZATION_PREFIX = 'Bearer '
 
 
-# TODO Align those methods with typescript-sdk https://github.com/circles-zone/typescript-sdk-remote-typescript-package/blob/dev/typescript-sdk/src/utils/index.ts
+# TODO Align those methods with typescript-sdk https://github.com/circles-zone/typescript-sdk-remote-typescript-package/blob/dev/typescript-sdk/src/utils/index.ts  # noqa: E501
 # TODO Shall we create also createInternalServerErrorHttpResponse(), createOkHttpResponse() like we have in TypeScript?
 
 # TODO: add handler wrapper?
@@ -104,7 +104,7 @@ def get_user_jwt_from_event(event: dict) -> str:
 def create_return_http_headers() -> dict:
     logger.start()
     # Adding "Access-Control-Allow-Origin" : "*" to take care of CORS from localhost
-    # TODO Do we need to add those? In which cases? try  adding crossDomain: true, to the request, 'Access-Control-Allow-Credentials': true to header
+    # TODO Do we need to add those? In which cases? try  adding crossDomain: true, to the request, 'Access-Control-Allow-Credentials': true to header  # noqa: E501
     return_http_headers = {
         "Content-Type": "application/json",
         "Access-Control-Allow-Origin": "*",

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/python_sdk_remote/src/mini_logger.py

@@ -2,12 +2,16 @@ import logging
 import os
 import sys
 
+# TODO LOGGER_MINIMAL_SEVERITY_DEFAULT
 LOGGER_MINIMUM_SEVERITY = os.getenv("LOGGER_MINIMUM_SEVERITY", "INFO").upper()
 # logging expects NOTSET/DEBUG/INFO/WARNING/ERROR/FATAL/CRITICAL
 if LOGGER_MINIMUM_SEVERITY.isdigit():
+    # TODO logger_minimal_severity_default_value
     logger_minimum_severity = int(LOGGER_MINIMUM_SEVERITY)
-    # Values from Logger.MessageSeverity
+    # TODO Change Magic Numbers and use the values from Logger.MessageSeverity
     if logger_minimum_severity < 400:
+        # TODO LOGGER_MINIMAL_SEVERITY_DEFAULT_NAME =
+        # TODO Change "DEBUG", "INFO", "WARNING" ... into enum values from Logger.MessageSeverity
         LOGGER_MINIMUM_SEVERITY = "DEBUG"
     elif logger_minimum_severity < 600:
         LOGGER_MINIMUM_SEVERITY = "INFO"
@@ -24,7 +28,9 @@ logger = logging.getLogger(__name__)
 
 
 class MiniLogger:
-    # TODO Can we so one generic function call by all
+    # TODO Can we have one generic function called by all as we have a lot of duplicated code here?
+
+    # TODO: print the caller function name
 
     @staticmethod
     def start(message: str = "", object: dict = None):
@@ -53,6 +59,8 @@ class MiniLogger:
         else:
             logger.debug(f"END - {message} - {object}")
 
+    # TODO convert all those methods (debug, info, warning, error) into one unified private method
+    # TODO Add to the unified private method print of the name of method, version and line number of the calling function/method to the mini_logger methods  # noqa: E501
     @staticmethod
     def debug(message: str = "", object: dict = None):
         """

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/python_sdk_remote/src/utilities.py

@@ -279,42 +279,53 @@ def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (dat
     return is_datetime_in_datetime_range_result
 
 
-def get_brand_name() -> str:
-    get_brand_name_result = our_get_env("BRAND_NAME")
+def get_brand_name(raise_if_not_found: bool = True,
+                   raise_if_empty: bool = False) -> str:
+    get_brand_name_result = our_get_env("BRAND_NAME",
+                                        raise_if_not_found=raise_if_not_found,
+                                        raise_if_empty=raise_if_empty)
     return get_brand_name_result
 
 
-def get_environment_name() -> str:
-    environment_name = our_get_env("ENVIRONMENT_NAME")
+def get_environment_name(raise_if_not_found: bool = True,
+                         raise_if_empty: bool = False) -> str:
+    environment_name = our_get_env("ENVIRONMENT_NAME",
+                                   raise_if_not_found=raise_if_not_found,
+                                   raise_if_empty=raise_if_empty)
     EnvironmentName(environment_name)  # if invalid, raises ValueError: x is not a valid EnvironmentName
     return environment_name
 
 
 def our_get_env(key: str, default: str = None, raise_if_not_found: bool = True,
                 raise_if_empty: bool = False) -> str:
-    logger.start(object={"key": key, "default": default, "raise_if_not_found": raise_if_not_found,
+    logger.start(object={"key": key, "default": default,
+                         "raise_if_not_found": raise_if_not_found,
                          "raise_if_empty": raise_if_empty})
     env_var = os.getenv(key, default)
+    # TODO: "default is None" is always False
     if ((raise_if_not_found and key not in os.environ and default is None)
             or (raise_if_empty and not env_var and not default)):
-        raise Exception(f"Environment variable {key} not found - please check your .env file")
+        raise Exception(f"Environment variable {key} not found - please check your .env file")  # noqa: E501
     logger.end(object={"env_var": env_var})
     return env_var
 
 
-# TODO As only the database package uses those, let's move those three to the database package
-def get_sql_hostname() -> str:
-    get_sql_hostname_result = our_get_env("RDS_HOSTNAME")
+# TODO As only the database package uses those, let's move those three to the database package  # noqa: E501
+def get_sql_hostname(raise_if_not_found: bool = True, raise_if_empty: bool = False) -> str:
+    get_sql_hostname_result = our_get_env("RDS_HOSTNAME",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_hostname_result
 
 
-def get_sql_username() -> str:
-    get_sql_username_result = our_get_env("RDS_USERNAME")
+def get_sql_username(raise_if_empty: bool = False) -> str:
+    get_sql_username_result = our_get_env("RDS_USERNAME",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_username_result
 
 
-def get_sql_password() -> str:
-    get_sql_password_result = our_get_env("RDS_PASSWORD")
+def get_sql_password(raise_if_empty: bool = False) -> str:
+    get_sql_password_result = our_get_env("RDS_PASSWORD",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_password_result
 
 

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.145
+Version: 0.0.147
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

{python_sdk_remote-0.0.145 → python_sdk_remote-0.0.147}/setup.py

@@ -7,7 +7,7 @@ package_dir = PACKAGE_NAME.replace("-", "_")
 # python -m build needs pyproject.toml or setup.py
 setuptools.setup(
     name=PACKAGE_NAME,
-    version='0.0.145',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.147',  # https://pypi.org/project/python-sdk-remote/
     author="Circles",
     author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",