api-to-dataframe 2.0.6__tar.gz → 2.1.0__tar.gz

{api_to_dataframe-2.0.6 → api_to_dataframe-2.1.0}/PKG-INFO

@@ -1,22 +1,20 @@
 Metadata-Version: 2.1
 Name: api-to-dataframe
-Version: 2.0.6
+Version: 2.1.0
 Summary: A package to convert API responses to pandas dataframe
 License: MIT
 Author: IvanildoBarauna
 Author-email: ivanildo.jnr@outlook.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.8
-Requires-Dist: logging (>=0.4.9.6,<0.5.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests (>=2.33.0,<3.0.0)
 Project-URL: Documentation, https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/README.md
 Project-URL: Homepage, https://pypi.org/project/api-to-dataframe
 Project-URL: ImplementationCase, https://github.com/IvanildoBarauna/ETL-awesome-api

{api_to_dataframe-2.0.6 → api_to_dataframe-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "2.0.6"
+version = "2.1.0"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
 readme = "README.md"
@@ -23,18 +23,17 @@ Issues = "https://github.com/IvanildoBarauna/api-to-dataframe/issues"
 Repository = "https://github.com/IvanildoBarauna/api-to-dataframe"
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 pandas = "^2.2.3"
-requests = "^2.32.3"
-logging = "^0.4.9.6"
+requests = "^2.33.0"
 
 [tool.poetry.group.dev.dependencies]
 poetry-dynamic-versioning = "^1.3.0"
-pytest = "^8.2.2"
+pytest = "^9.0.3"
 coverage = "^7.5.3"
 responses = ">=0.25.3,<0.27.0"
 pylint = "^3.2.5"
-black = "^24.4.2"
+black = "^26.3.1"
 pytest-cov = "^7.0.0"
 
 

{api_to_dataframe-2.0.6 → api_to_dataframe-2.1.0}/src/api_to_dataframe/controller/client_builder.py

@@ -7,11 +7,11 @@ class ClientBuilder:
     def __init__(  # pylint: disable=too-many-positional-arguments,too-many-arguments
         self,
         endpoint: str,
-        headers: dict = None,
+        headers: dict | None = None,
         retry_strategy: Strategies = Strategies.NO_RETRY_STRATEGY,
         retries: int = 3,
         initial_delay: int = 1,
-        connection_timeout: int = 1,
+        connection_timeout: int = 10,
     ):
         """
         Initializes the ClientBuilder object.
@@ -20,14 +20,14 @@ class ClientBuilder:
             endpoint (str): The API endpoint to connect to.
             headers (dict, optional): The headers to use for the API request. Defaults to None.
             retry_strategy (Strategies, optional): Defaults to Strategies.NO_RETRY_STRATEGY.
-            retries (int): The number of times to retry a failed request. Defaults to 3.
+            retries (int): The number of attempts to make. Must be >= 1. Defaults to 3.
             initial_delay (int): The delay between retries in seconds. Defaults to 1.
-            connection_timeout (int): The timeout for the connection in seconds. Defaults to 1.
+            connection_timeout (int): The timeout for the connection in seconds. Defaults to 10.
 
         Raises:
             ValueError: If endpoint is an empty string.
-            ValueError: If retries is not a non-negative integer.
-            ValueError: If delay is not a non-negative integer.
+            ValueError: If retries is not a positive integer (>= 1).
+            ValueError: If initial_delay is not a non-negative integer.
             ValueError: If connection_timeout is not a non-negative integer.
         """
 
@@ -36,19 +36,19 @@ class ClientBuilder:
         if endpoint == "":
             error_msg = "endpoint cannot be an empty string"
             logger.error(error_msg)
-            raise ValueError
-        if not isinstance(retries, int) or retries < 0:
-            error_msg = "retries must be a non-negative integer"
+            raise ValueError(error_msg)
+        if not isinstance(retries, int) or isinstance(retries, bool) or retries < 1:
+            error_msg = "retries must be a positive integer (>= 1)"
             logger.error(error_msg)
-            raise ValueError
-        if not isinstance(initial_delay, int) or initial_delay < 0:
+            raise ValueError(error_msg)
+        if not isinstance(initial_delay, int) or isinstance(initial_delay, bool) or initial_delay < 0:
             error_msg = "initial_delay must be a non-negative integer"
             logger.error(error_msg)
-            raise ValueError
-        if not isinstance(connection_timeout, int) or connection_timeout < 0:
+            raise ValueError(error_msg)
+        if not isinstance(connection_timeout, int) or isinstance(connection_timeout, bool) or connection_timeout < 0:
             error_msg = "connection_timeout must be a non-negative integer"
             logger.error(error_msg)
-            raise ValueError
+            raise ValueError(error_msg)
 
         self.endpoint = endpoint
         self.retry_strategy = retry_strategy
@@ -58,14 +58,10 @@ class ClientBuilder:
         self.delay = initial_delay
 
     @retry_strategies
-    def get_api_data(self):
+    def get_api_data(self) -> dict:
         """
         Retrieves data from the API using the defined endpoint and retry strategy.
 
-        This function sends a request to the API using the endpoint, headers, and
-        connection timeout specified in the instance attributes. It uses the
-        defined retry strategy to handle potential failures and retries.
-
         Returns:
             dict: The JSON response from the API as a dictionary.
         """
@@ -82,10 +78,6 @@ class ClientBuilder:
         """
         Converts an API response to a DataFrame.
 
-        This function takes a dictionary response from an API,
-        uses the `to_dataframe` function from the `GetData` class
-        to convert it into a DataFrame, and logs the operation as successful.
-
         Args:
             response (dict): The dictionary containing the API response.
 

{api_to_dataframe-2.0.6 → api_to_dataframe-2.1.0}/src/api_to_dataframe/models/retainer.py

@@ -13,13 +13,13 @@ class Strategies(Enum):
 
 
 def retry_strategies(func):
-    def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
+    def wrapper(*args, **kwargs):
         retry_number = 0
         while retry_number < args[0].retries:
             try:
                 if retry_number > 0:
                     logger.info(
-                        f"Trying for the {retry_number} of {Constants.MAX_OF_RETRIES} retries. Using {args[0].retry_strategy}"
+                        f"Attempt {retry_number} of {min(args[0].retries, Constants.MAX_OF_RETRIES)}. Strategy: {args[0].retry_strategy}"
                     )
                 return func(*args, **kwargs)
             except RequestException as e:
@@ -27,13 +27,13 @@ def retry_strategies(func):
 
                 if args[0].retry_strategy == Strategies.NO_RETRY_STRATEGY:
                     raise e
-                if args[0].retry_strategy == Strategies.LINEAR_RETRY_STRATEGY:
+                elif args[0].retry_strategy == Strategies.LINEAR_RETRY_STRATEGY:
                     time.sleep(args[0].delay)
                 elif args[0].retry_strategy == Strategies.EXPONENTIAL_RETRY_STRATEGY:
                     time.sleep(args[0].delay * retry_number)
 
                 if retry_number in (args[0].retries, Constants.MAX_OF_RETRIES):
-                    logger.error(f"Failed after {retry_number} retries")
+                    logger.error(f"Failed after {retry_number} attempts")
                     raise e
 
     return wrapper

api_to_dataframe-2.1.0/src/api_to_dataframe/utils/logger.py

@@ -0,0 +1,4 @@
+import logging
+
+logger = logging.getLogger("api-to-dataframe")
+logger.addHandler(logging.NullHandler())

api_to_dataframe-2.0.6/src/api_to_dataframe/utils/logger.py

@@ -1,11 +0,0 @@
-import logging
-
-logging.basicConfig(
-    encoding="utf-8",
-    format="%(asctime)s :: api-to-dataframe[%(levelname)s] :: %(message)s",
-    datefmt="%Y-%m-%d %H:%M:%S %Z",
-    level=logging.INFO,
-)
-
-# Initialize traditional logger
-logger = logging.getLogger("api-to-dataframe")