python-base-toolkit 0.0.1__tar.gz → 0.0.3__tar.gz

{python_base_toolkit-0.0.1/python_base_toolkit.egg-info → python_base_toolkit-0.0.3}/PKG-INFO

@@ -1,36 +1,34 @@
 Metadata-Version: 2.4
 Name: python-base-toolkit
-Version: 0.0.1
+Version: 0.0.3
 Summary: A Python package for managing pytest plugins.
-Home-page: https://github.com/aviz92/python-base-toolkit
 Author: Avi Zaguri
-Author-email: 
+License: MIT
+Project-URL: Homepage, https://github.com/aviz92/python-base-toolkit
 Project-URL: Repository, https://github.com/aviz92/python-base-toolkit
-Classifier: Framework :: Pytest
-Classifier: Programming Language :: Python
+Project-URL: Issues, https://github.com/aviz92/python-base-toolkit/issues
+Keywords: development,python,toolkit,utilities
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Logging
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: wheel
-Requires-Dist: colorlog
-Requires-Dist: pathlib
-Requires-Dist: requests
-Requires-Dist: PyYAML
-Requires-Dist: tqdm
-Requires-Dist: pyfiglet
-Requires-Dist: pandas
-Requires-Dist: custom-python-logger
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Requires-Dist: colorlog>=6.10.1
+Requires-Dist: custom-python-logger>=2.0.10
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pathlib>=1.0.1
+Requires-Dist: pre-commit>=4.5.0
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.32.5
+Requires-Dist: setuptools>=80.9.0
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: wheel>=0.45.1
 Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # Python Toolkit
 A powerful, production-ready Python toolkit designed to accelerate development by providing essential utilities and common functionality across multiple domains. <br>
@@ -47,15 +45,15 @@ pip install python-toolkit
 ---
 
 ## 🚀 Features
-- Constants Pack 
-  - binary 
+- Constants Pack
+  - binary
   - time
 
 - Decorators Pack
   - telemetry
   - timer
 
-- Instances Pack 
+- Instances Pack
   - instance_manager
 
 - Utilities Pack

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/README.md

@@ -13,15 +13,15 @@ pip install python-toolkit
 ---
 
 ## 🚀 Features
-- Constants Pack 
-  - binary 
+- Constants Pack
+  - binary
   - time
 
 - Decorators Pack
   - telemetry
   - timer
 
-- Instances Pack 
+- Instances Pack
   - instance_manager
 
 - Utilities Pack

python_base_toolkit-0.0.3/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python-base-toolkit"
+version = "0.0.3"
+description = "A Python package for managing pytest plugins."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [{ name = "Avi Zaguri" },]
+keywords = ["development", "python", "toolkit", "utilities"]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Logging",
+]
+
+dependencies = [
+    "colorlog>=6.10.1",
+    "custom-python-logger>=2.0.10",
+    "pandas>=2.3.3",
+    "pathlib>=1.0.1",
+    "pre-commit>=4.5.0",
+    "pyfiglet>=1.0.4",
+    "python-dotenv>=1.2.1",
+    "pyyaml>=6.0.3",
+    "requests>=2.32.5",
+    "setuptools>=80.9.0",
+    "tqdm>=4.67.1",
+    "wheel>=0.45.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/aviz92/python-base-toolkit"
+Repository = "https://github.com/aviz92/python-base-toolkit"
+Issues = "https://github.com/aviz92/python-base-toolkit/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["python_base_toolkit*"]
+namespaces = false

python_base_toolkit-0.0.3/python_base_toolkit/consts/operating_system.py

@@ -0,0 +1,4 @@
+class Platform:
+    WINDOWS = "Windows"
+    LINUX = "Linux"
+    MACOS = "macOS"

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/consts/units/__init__.py

@@ -2,6 +2,6 @@ import python_base_toolkit.consts.units.binary_units
 import python_base_toolkit.consts.units.time_units
 
 __all__ = [
-    'binary_units',
-    'time_units',
+    "binary_units",
+    "time_units",
 ]

python_base_toolkit-0.0.3/python_base_toolkit/consts/units/binary_units.py

@@ -0,0 +1,13 @@
+B = 8
+KiB = 1024
+MiB = KiB * 1024
+GiB = MiB * 1024
+TiB = GiB * 1024
+PiB = TiB * 1024
+EiB = PiB * 1024
+
+KB = 1000  # 1 kilobyte (KB) = 1000 bytes in decimal (SI)
+GB = 1000**3  # 1 gigabyte (GB) = 1000^3 bytes in decimal (SI)
+TB = 1000**4  # 1 terabyte (TB) = 1000^4 bytes in decimal (SI)
+PB = 1000**5  # 1 petabyte (PB) = 1000^5 bytes in decimal (SI)
+EB = 1000**6  # 1 exabyte (EB) = 1000^6 bytes in decimal (SI)

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/decorators/telemetry.py

@@ -1,8 +1,9 @@
+import datetime
 import json
 import time
+from collections.abc import Callable
 from functools import wraps
-import datetime
-from typing import Callable, Any
+from typing import Any
 
 from custom_python_logger import get_logger
 
@@ -10,11 +11,7 @@ logger = get_logger(__name__)
 
 
 def report_telemetry(
-    func: Callable[..., Any],
-    start_time: datetime.datetime,
-    end_time: datetime.datetime,
-    *args: Any,
-    **kwargs: Any
+    func: Callable[..., Any], start_time: datetime.datetime, end_time: datetime.datetime, *args: Any, **kwargs: Any
 ) -> None:
     data = {
         "function_name": func.__name__,
@@ -25,7 +22,8 @@ def report_telemetry(
         "timestamp": time.time(),
     }
     logger.info(
-        f"Sending telemetry data with the following data: {json.dumps(data, indent=4, sort_keys=False, default=str)}")
+        f"Sending telemetry data with the following data: {json.dumps(data, indent=4, sort_keys=False, default=str)}"
+    )
 
 
 def report_func_telemetry(func: Callable[..., Any]) -> Callable[..., Any]:
@@ -37,7 +35,7 @@ def report_func_telemetry(func: Callable[..., Any]) -> Callable[..., Any]:
         start_time = datetime.datetime.now(datetime.UTC)
         result = func(*args, **kwargs)
         end_time = datetime.datetime.now(datetime.UTC)
-        report_telemetry(func=func, start_time=start_time, end_time=end_time, *args, **kwargs)
+        report_telemetry(*args, func=func, start_time=start_time, end_time=end_time, **kwargs)
         return result
 
     return wrapper

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/decorators/timer.py

@@ -1,6 +1,7 @@
 import time
+from collections.abc import Callable
 from functools import wraps
-from typing import Callable, Any
+from typing import Any
 
 from custom_python_logger import get_logger
 
@@ -8,12 +9,17 @@ logger = get_logger(__name__)
 
 
 class Timer:
-    def __enter__(self):
+    def __init__(self) -> None:
+        self.start_time = None
+        self.end_time = None
+        self.elapsed_time = None
+
+    def __enter__(self) -> "Timer":
         self.start_time = time.perf_counter()
         logger.info("Timer started.")
         return self
 
-    def __exit__(self, exc_type, exc_value, exc_traceback):
+    def __exit__(self, exc_type: type, exc_value: Exception, exc_traceback: object) -> None:
         # logger.info(exc_type, exc_value, exc_traceback)
         self.end_time = time.perf_counter()
         self.elapsed_time = self.end_time - self.start_time
@@ -25,4 +31,5 @@ def timer(func: Callable[..., Any]) -> Callable[..., Any]:
     def wrapper(*args: Any, **kwargs: Any) -> Any:
         with Timer():
             return func(*args, **kwargs)
+
     return wrapper

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/instances/instance_manager.py

@@ -1,18 +1,19 @@
 from custom_python_logger.logger import get_logger
 
+
 class InstanceManager:
-    def __init__(self):
+    def __init__(self) -> None:
         self.logger = get_logger(__class__.__name__)
         self._instances = []
 
-    def add(self, instance):
+    def add(self, instance: object) -> None:
         self._instances.append(instance)
 
-    def close_all(self):
+    def close_all(self) -> None:
         for instance in reversed(self._instances):
             _instance_name = instance.__class__.__name__
             try:
-                if hasattr(instance, 'close'):
+                if hasattr(instance, "close"):
                     instance.close()
                 else:  # hasattr(instance, '__exit__'):
                     instance.__exit__(None, None, None)
@@ -20,31 +21,31 @@ class InstanceManager:
             except Exception as e:
                 self.logger.info(f"Failed to close instance {instance}: {e}")
 
-    def __enter__(self):
+    def __enter__(self) -> "InstanceManager":
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self, exc_type: type, exc_value: Exception, traceback: object) -> None:
         self.close_all()
 
 
-def main():
+def main() -> None:
     class SomeInstance:
-        def __init__(self, add_to_instance_manager: bool = False):
+        def __init__(self, add_to_instance_manager: bool = False) -> None:
             self.logger = get_logger(__class__.__name__)
 
             if add_to_instance_manager:
-                instance_manager.add(self)
+                instance_manager.add(self)  # pylint: disable=E0601
 
         @property
-        def __class_name__(self):
+        def class_name(self) -> str:
             return self.__class__.__name__
 
-        def __enter__(self):
-            self.logger.info(f"Entering {self.__class_name__}")
+        def __enter__(self) -> "SomeInstance":
+            self.logger.info(f"Entering {self.class_name}")
             return self
 
-        def __exit__(self, exc_type, exc_value, exc_traceback):
-            self.logger.info(f"Exiting {self.__class_name__}")
+        def __exit__(self, exc_type: type, exc_value: Exception, traceback: object) -> bool:
+            self.logger.info(f"Exiting {self.class_name}")
             # Handle any cleanup here
             if exc_type:
                 self.logger.info(f"Exception: {exc_value}")
@@ -52,8 +53,8 @@ def main():
 
     SomeInstance(add_to_instance_manager=True)
 
-    resource1 = open('file1.txt', 'w')
-    resource2 = open('file2.txt', 'w')
+    resource1 = open("file1.txt", "w")  # pylint: disable=R1732
+    resource2 = open("file2.txt", "w")  # pylint: disable=R1732
 
     instance_manager.add(resource1)
     instance_manager.add(resource2)

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/utils/data_serialization.py

@@ -1,6 +1,6 @@
 import json
 from dataclasses import is_dataclass
-from datetime import datetime, date, time
+from datetime import date, datetime, time
 from decimal import Decimal
 from enum import Enum
 from pathlib import Path
@@ -23,7 +23,7 @@ def default_serialize(obj: object) -> object:
         return list(obj)
     if isinstance(obj, tuple):
         return list(obj)
-    if isinstance(obj, (datetime, date, time)):
+    if isinstance(obj, datetime | date | time):
         return obj.isoformat()
     if isinstance(obj, Decimal):
         return float(obj)
@@ -31,7 +31,7 @@ def default_serialize(obj: object) -> object:
         return str(obj)
     if obj is pd.NA:
         return None
-    logger.error(f'Object is not serializable: {obj}')
+    logger.error(f"Object is not serializable: {obj}")
     raise TypeError(f"Type {type(obj)} not serializable")
 
 

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/utils/date_time.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from zoneinfo import ZoneInfo
 
-utc_timezone = ZoneInfo('UTC')
+utc_timezone = ZoneInfo("UTC")
 
 
 def datetime_now_with_timezone(timezone: ZoneInfo = utc_timezone) -> datetime:
@@ -9,6 +9,6 @@ def datetime_now_with_timezone(timezone: ZoneInfo = utc_timezone) -> datetime:
         raise TypeError(f"Expected pytz timezone, got {type(timezone).__name__}")
 
     now_utc = datetime.now(timezone)
-    if timezone.key == 'UTC':
+    if timezone.key == "UTC":
         return now_utc
     return now_utc.astimezone(timezone)

{python_base_toolkit-0.0.1 → python_base_toolkit-0.0.3}/python_base_toolkit/utils/execute.py

@@ -16,7 +16,7 @@ def _timed_execution(
     pbar = tqdm(total=timeout, desc=pb_description, unit="s", ncols=100)
     start_time = time()
 
-    while time() - start_time < timeout:
+    while time() - start_time < timeout:  # pylint: disable=W0149
         res = func()
         if (expect_true and res) or (not expect_true and not res):
             pbar.close()