python-sdk-remote 0.0.129__tar.gz → 0.0.131__tar.gz

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.129
+Version: 0.0.131
 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.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/http_response.py

@@ -1,25 +1,25 @@
 import traceback
+from datetime import date
 from functools import wraps
 from http import HTTPStatus
 from typing import Any
 
 from .mini_logger import MiniLogger as logger
-from datetime import date
-from . import temp
+from .temp import deprecation_warning
 from .utilities import camel_to_snake, snake_to_camel, to_dict, to_json
 
 HEADERS_KEY = 'headers'
 AUTHORIZATION_KEY = 'authorization'
 AUTHORIZATION_PREFIX = 'Bearer '
 
-temp.deprecation_warning("http_response","DELETE",date(2024,7,25))
+# TODO: move date(2024, 6, 5) to constants and use it everywhere
+deprecation_warning("http_response", "DELETE", date(2024, 6, 5))
+
 
 # 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 Shall we create also createInternalServerErrorHttpResponse(), createOkHttpResponse() like we have in TypeScript?
 
-# TODO: add handler wrapper?
-
-#TODO Shall we add the word body? i.e. get_body_payload_idct_from_event()
+# TODO Shall we add the word body? i.e. get_body_payload_dict_from_event()
 def get_payload_dict_from_event(event: dict) -> dict:
     """Extracts params sent with payload"""
     return to_dict(event.get('body'))
@@ -80,8 +80,9 @@ def handler_decorator(logger):
 
 # TODO: should we auto detect user_jwt if not provided?
 def create_authorization_http_headers(user_jwt: str) -> dict:
+    # Not deprecated - we need it in remote packages
     logger.start(object={"user_jwt": user_jwt})
-    #TODO check the validity of user_jwt and it is not None and raise exception, please do the same in all other functions.
+    # TODO check the validity of user_jwt and it is not None and raise exception, please do the same in all other functions.
     authorization_http_headers = {
         'Content-Type': 'application/json',
         'Authorization': AUTHORIZATION_PREFIX + user_jwt,
@@ -117,8 +118,8 @@ def create_error_http_response(exception: Exception, status_code: HTTPStatus = H
     error_http_response = {
         "statusCode": status_code.value,
         "headers": create_return_http_headers(),
-        "body": create_http_body({"error": str(exception)}),
-        "traceback": traceback.format_exc()
+        "body": create_http_body({"error": str(exception),
+                                  "traceback": traceback.format_exc()}),
     }
     logger.end(object={"error_http_response": error_http_response})
     return error_http_response

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/item.py

@@ -1,12 +1,13 @@
 from abc import abstractmethod
+from datetime import date
 
 from .our_object import OurObject
-from datetime import date
-from . import temp
+from .temp import deprecation_warning
+
 
 class Item(OurObject):
     def __init__(self, **kwargs):
-        temp.deprecation_warning("item","DELETE",date(2024,7,25))
+        deprecation_warning("item", "DELETE", date(2024, 6, 5))
         super().__init__(**kwargs)
 
     @abstractmethod

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/mini_logger.py

@@ -2,7 +2,10 @@ import logging
 import os
 import sys
 
-LOGGER_MINIMUM_SEVERITY = os.getenv("LOGGER_MINIMUM_SEVERITY", "INFO").upper()
+# Try to get MINI_LOGGER_MINIMUM_SEVERITY from the environment, if not found, try to get LOGGER_MINIMUM_SEVERITY
+# If not found, default to INFO
+LOGGER_MINIMUM_SEVERITY = os.getenv("MINI_LOGGER_MINIMUM_SEVERITY",
+                                    os.getenv("LOGGER_MINIMUM_SEVERITY", "INFO")).upper()
 # logging expects NOTSET/DEBUG/INFO/WARNING/ERROR/FATAL/CRITICAL
 if LOGGER_MINIMUM_SEVERITY.isdigit():
     logger_minimum_severity = int(LOGGER_MINIMUM_SEVERITY)
@@ -25,7 +28,7 @@ logger = logging.getLogger(__name__)
 
 class MiniLogger:
     # TODO Can we so one generic function call by all
-
+    # TODO: print the caller function name
     @staticmethod
     def start(message: str = "", object: dict = None):
         """

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/our_object.py

@@ -1,15 +1,15 @@
 import json
 from abc import ABC, abstractmethod
+from datetime import date
 
 from .mini_logger import MiniLogger as logger
-from datetime import date
-from . import temp
+from .temp import deprecation_warning
 
 
 # TODO Where are we using it? Shall we extend the usage of OurObject as the father of all our entities?
 class OurObject(ABC):
     def __init__(self, **kwargs):
-        temp.deprecation_warning("our_object","DELETE",date(2024,7,25))
+        deprecation_warning("our_object", "DELETE", date(2024, 6, 5))
         INIT_METHOD_NAME = '__init__'
         logger.start(INIT_METHOD_NAME, object={'kwargs': kwargs})
         self.kwargs = kwargs

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/temp.py

@@ -1,15 +1,18 @@
-from functools import lru_cache
-from datetime import date
+# TODO: remove once all breaking changes related to deprecation are done
 import inspect
+from datetime import date
+from functools import lru_cache
+
 from .mini_logger import MiniLogger as logger
 
+
 @lru_cache(maxsize=64)  # don't print the same warning multiple times
 def deprecation_warning(old_name: str, new_name: str, start_date: date = None) -> None:
     if start_date and start_date < date.today():
         return
-    warnings_message = f"Please use {old_name} instead of {new_name}."
+    warnings_message = f"{new_name} {old_name} and use the local version."
     try:
         warnings_message += " Called from: " + inspect.stack()[2].filename
     except Exception:
         pass
-    logger.warning(warnings_message)
+    logger.warning(warnings_message)

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/unified_json.py

@@ -1,11 +1,13 @@
-from .valid_json_versions import valid_json_versions
 from datetime import date
-from . import temp
+
+from .temp import deprecation_warning
+from .valid_json_versions import valid_json_versions
+
 
 # TODO Shall we merge it with the machine-learning-unified-json?
 class UnifiedJson:
     def __init__(self, data: dict, json_version: str):
-        temp.deprecation_warning("unified_json","DELETE",date(2024,7,25))
+        deprecation_warning("unified_json", "DELETE", date(2024, 6, 5))
         if json_version not in valid_json_versions:
             raise Exception(
                 f"version {json_version} is not in valid_json_versions {valid_json_versions}, "

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote/src/utilities.py

@@ -1,12 +1,9 @@
-import inspect
 import json
 import os
 import random
 import re
 from datetime import date, datetime, time, timedelta, timezone
-from functools import lru_cache
 from urllib.parse import urlparse
-from . import temp
 
 import jwt
 import requests
@@ -14,6 +11,7 @@ from dotenv import load_dotenv
 from url_remote.environment_name_enum import EnvironmentName
 
 from .mini_logger import MiniLogger as logger
+from .temp import deprecation_warning
 
 load_dotenv()
 # TODO Let's do brainstorming on this
@@ -34,22 +32,22 @@ DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
 
 
 def append_if_not_exist(lst: list, item: object) -> None:
-    temp.deprecation_warning("append_if_not_exist","DELETE",date(2024,7,25))
+    deprecation_warning("append_if_not_exist", "DELETE", date(2024, 6, 5))
     if item not in lst:
         lst.append(item)
 
 
 def to_dict(data: json or dict or None) -> dict:
-    temp.deprecation_warning("to_dict","DELETE",date(2024,7,25))
+    deprecation_warning("to_dict", "DELETE", date(2024, 6, 5))
     if data is None:
         return {}
     if isinstance(data, dict):
         return data
-    return json.loads(data)
+    return json.loads(data)  # TODO: replace all `return statement` with `return identifier`
 
 
 def to_json(data: json or dict or None) -> json:
-    temp.deprecation_warning("to_json","DELETE",date(2024,7,25))
+    deprecation_warning("to_json", "DELETE", date(2024, 6, 5))
     if data is None:
         data = {}
     if isinstance(data, dict):
@@ -58,7 +56,7 @@ def to_json(data: json or dict or None) -> json:
 
 
 def timedelta_to_time_format(time_delta: timedelta) -> str:
-    temp.deprecation_warning("timedelta_to_time_format","DELETE",date(2024,7,25))
+    deprecation_warning("timedelta_to_time_format", "DELETE", date(2024, 6, 5))
     """
     Convert a timedelta to a time format in HH:MM:SS.
 
@@ -95,7 +93,7 @@ def timedelta_to_time_format(time_delta: timedelta) -> str:
 
 
 def is_valid_time_range(time_range: tuple) -> bool:
-    temp.deprecation_warning("is_valid_time_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_valid_time_range", "DELETE", date(2024, 6, 5))
     """
     Validate that the time range is in the format 'HH:MM:SS'.
     """
@@ -122,7 +120,7 @@ def is_valid_time_range(time_range: tuple) -> bool:
 # TODO shall we also use Url type and not only str? - Strongly Type which I prefer
 #   (if yes we should change it also in all the calls to this function)
 def validate_url(url: str):
-    temp.deprecation_warning("validate_url","DELETE",date(2024,7,25))
+    deprecation_warning("validate_url", "DELETE", date(2024, 6, 5))
     logger.start(object={"url": url})
     if url is not None or url != "":
         parsed_url = urlparse(url)
@@ -134,7 +132,7 @@ def validate_url(url: str):
 
 
 def is_valid_date_range(date_range: tuple) -> bool:
-    temp.deprecation_warning("is_valid_date_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_valid_date_range", "DELETE", date(2024, 6, 5))
     """
     Validate that the date range is in the format 'YYYY-MM-DD'.
     """
@@ -153,7 +151,7 @@ def is_valid_date_range(date_range: tuple) -> bool:
 
 
 def is_valid_datetime_range(datetime_range: (datetime, datetime)) -> bool:
-    temp.deprecation_warning("is_valid_datetime_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_valid_datetime_range", "DELETE", date(2024, 6, 5))
     """
     Validate that the datetime range is in the format 'YYYY-MM-DD HH:MM:SS'.
     """
@@ -171,7 +169,7 @@ def is_valid_datetime_range(datetime_range: (datetime, datetime)) -> bool:
 
 
 def is_list_of_dicts(obj: object) -> bool:
-    temp.deprecation_warning("is_list_of_dicts","DELETE",date(2024,7,25))
+    deprecation_warning("is_list_of_dicts", "DELETE", date(2024, 6, 5))
     """
     Check if an object is a list of dictionaries.
 
@@ -216,7 +214,7 @@ def is_list_of_dicts(obj: object) -> bool:
 
 
 def is_time_in_time_range(check_time: time, time_range: tuple) -> bool:
-    temp.deprecation_warning("is_time_in_time_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_time_in_time_range", "DELETE", date(2024, 6, 5))
     """
     Check if the given time is within the specified time range.
 
@@ -240,7 +238,7 @@ def is_time_in_time_range(check_time: time, time_range: tuple) -> bool:
 
 
 def is_date_in_date_range(check_date: date, date_range: tuple) -> bool:
-    temp.deprecation_warning("is_date_in_date_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_date_in_date_range", "DELETE", date(2024, 6, 5))
     """
     Check if the given date is within the specified date range.
 
@@ -265,7 +263,7 @@ def is_date_in_date_range(check_date: date, date_range: tuple) -> bool:
 
 
 def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (datetime, datetime)) -> bool:
-    temp.deprecation_warning("is_datetime_in_datetime_range","DELETE",date(2024,7,25))
+    deprecation_warning("is_datetime_in_datetime_range", "DELETE", date(2024, 6, 5))
     """
     Check if the given datetime is within the specified datetime range.
 
@@ -290,11 +288,11 @@ def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (dat
 
 
 def get_brand_name() -> str:
-    return our_get_env("BRAND_NAME")
+    return our_get_env("BRAND_NAME", raise_if_empty=True)
 
 
 def get_environment_name() -> str:
-    environment_name = our_get_env("ENVIRONMENT_NAME")
+    environment_name = our_get_env("ENVIRONMENT_NAME", raise_if_empty=True)
     EnvironmentName(environment_name)  # if invalid, raises ValueError: x is not a valid EnvironmentName
     return environment_name
 
@@ -313,15 +311,15 @@ def our_get_env(key: str, default: str = None, raise_if_not_found: bool = True,
 
 # TODO As only the database package uses those, let's move those three to the database package
 def get_sql_hostname() -> str:
-    return our_get_env("RDS_HOSTNAME")
+    return our_get_env("RDS_HOSTNAME", raise_if_empty=True)
 
 
 def get_sql_username() -> str:
-    return our_get_env("RDS_USERNAME")
+    return our_get_env("RDS_USERNAME", raise_if_empty=True)
 
 
 def get_sql_password() -> str:
-    return our_get_env("RDS_PASSWORD")
+    return our_get_env("RDS_PASSWORD", raise_if_empty=True)
 
 
 def get_dialog_jwt_secret_key() -> str:
@@ -329,7 +327,7 @@ def get_dialog_jwt_secret_key() -> str:
 
 
 def encode_jwt(payload: dict, key: str) -> str:
-    temp.deprecation_warning("encode_jwt","DELETE",date(2024,7,25))
+    deprecation_warning("encode_jwt", "DELETE", date(2024, 6, 5))
     """Example:
     payload = {
         "user_id": 123,
@@ -341,71 +339,42 @@ def encode_jwt(payload: dict, key: str) -> str:
 
 
 def decode_jwt(token: str, key: str) -> dict:
-    temp.deprecation_warning("decode_jwt","DELETE",date(2024,7,25))
+    deprecation_warning("decode_jwt", "DELETE", date(2024, 6, 5))
     """key can be private / public"""
     return jwt.decode(token, key, algorithms=['HS256'])
 
-
-def obfuscate_log_dict(log_dict: dict) -> dict:
-    """
-    Obfuscate keys:
-    - %password%
-    - %secret%
-    - %token%
-    - %jwt%
-    - %e%mail%
-    - %phone%
-    - %name% (first / last / nick / user etc.)
-    - %address%
-    - %ssn%
-    """
-    environment_name = get_environment_name()
-    if environment_name == EnvironmentName.PLAY1.value:
-        return log_dict
-    obfuscated_log_dict = {}
-    for key, value in log_dict.items():
-        if isinstance(value, dict):
-            obfuscated_log_dict[key] = obfuscate_log_dict(value)
-        elif re.search(r'password|secret|token|jwt|e[\-_]?mail|phone|name|address|ssn', key, re.IGNORECASE):
-            # TODO Maybe we can reveal a small part
-            obfuscated_log_dict[key] = "***"
-        else:
-            obfuscated_log_dict[key] = value
-    return obfuscated_log_dict
-
-
 # TODO: add tests to the following functions
 
 def remove_digits(text: str) -> str:
-    temp.deprecation_warning("remove_digits","DELETE",date(2024,7,25))
+    deprecation_warning("remove_digits", "DELETE", date(2024, 6, 5))
     return ''.join(i for i in text if not i.isdigit())
 
 
 def generate_otp():
-    temp.deprecation_warning("generate_otp","DELETE",date(2024,7,25))
+    deprecation_warning("generate_otp", "DELETE", date(2024, 6, 5))
     """Generates a 6-digit OTP"""
     otp = random.randint(100000, 999999)
     return otp
 
 
 def get_current_datetime_string(datetime_format: str = DEFAULT_DATETIME_FORMAT, tz: timezone = None) -> str:
-    temp.deprecation_warning("get_current_datetime_string","DELETE",date(2024,7,25))
+    deprecation_warning("get_current_datetime_string", "DELETE", date(2024, 6, 5))
     current_datetime_string = datetime.now(tz).strftime(datetime_format)
     return current_datetime_string
 
 
 def datetime_from_str(date_str: str, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> datetime:
-    temp.deprecation_warning("datetime_from_str","DELETE",date(2024,7,25))
+    deprecation_warning("datetime_from_str", "DELETE", date(2024, 6, 5))
     return datetime.strptime(date_str, datetime_format)
 
 
 def datetime_to_str(input_datetime: datetime, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> str:
-    temp.deprecation_warning("datetime_to_str","DELETE",date(2024,7,25))
+    deprecation_warning("datetime_to_str", "DELETE", date(2024, 6, 5))
     return input_datetime.strftime(datetime_format)
 
 
 def validate_arguments(args: dict) -> None:
-    temp.deprecation_warning("validate_arguments","DELETE",date(2024,7,25))
+    deprecation_warning("validate_arguments", "DELETE", date(2024, 6, 5))
     """
     Validate method arguments to ensure they are not None or ''
     :param args: arguments to be validated (usually locals())
@@ -417,7 +386,7 @@ def validate_arguments(args: dict) -> None:
 
 
 def reformat_time_string(input_str: str) -> str:
-    temp.deprecation_warning("reformat_time_string","DELETE",date(2024,7,25))
+    deprecation_warning("reformat_time_string", "DELETE", date(2024, 6, 5))
     """Example:
     "1234" -> "12:34:00:00"
     """
@@ -431,12 +400,12 @@ def reformat_time_string(input_str: str) -> str:
 
 
 def get_ip_v4():
-    temp.deprecation_warning("get_ip_v4","DELETE",date(2024,7,25))
+    deprecation_warning("get_ip_v4", "DELETE", date(2024, 6, 5))
     return requests.get('https://ipv4.seeip.org/jsonip').json()['ip']
 
 
 def get_ip_v6():
-    temp.deprecation_warning("get_ip_v6","DELETE",date(2024,7,25))
+    deprecation_warning("get_ip_v6", "DELETE", date(2024, 6, 5))
     return requests.get('https://api.seeip.org/jsonip').json()['ip']
 
 
@@ -451,5 +420,3 @@ def camel_to_snake(camel_str: str) -> str:
     """Converts camelCase to snake_case."""
     snake_str = re.sub(r'(?<!^)(?=[A-Z])', '_', camel_str).lower()
     return snake_str
-
-

{python_sdk_remote-0.0.129 → python_sdk_remote-0.0.131}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.129
+Version: 0.0.131
 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.129 → python_sdk_remote-0.0.131}/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.129',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.131',  # https://pypi.org/project/python-sdk-remote/
     author="Circles",
     author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",