feat: Improve Docs, fix level logger to INFO and remove _get_response_data

Author: IvanildoBarauna

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.3.0"
+version = "1.3.1"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
 readme = "README.md"

src/api_to_dataframe/controller/client_builder.py

@@ -19,10 +19,10 @@ def __init__(  # pylint: disable=too-many-arguments
         Args:
             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.NoRetryStrategy.
+            retry_strategy (Strategies, optional): Defaults to Strategies.NO_RETRY_STRATEGY.
             retries (int): The number of times to retry a failed request. 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 2.
+            connection_timeout (int): The timeout for the connection in seconds. Defaults to 1.
 
         Raises:
             ValueError: If endpoint is an empty string.
@@ -58,8 +58,12 @@ def get_api_data(self):
         """
         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 response from the API.
+            dict: The JSON response from the API as a dictionary.
         """
         response = GetData.get_response(
             endpoint=self.endpoint,
@@ -69,16 +73,21 @@ def get_api_data(self):
 
         return response.json()
 
-    def _get_raw_api_data(self):
-        response = GetData.get_response(
-            endpoint=self.endpoint,
-            headers=self.headers,
-            connection_timeout=self.connection_timeout,
-        )
-        return response
-
     @staticmethod
     def api_to_dataframe(response: dict):
+        """
+        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.
+
+        Returns:
+            DataFrame: A pandas DataFrame containing the data from the API response.
+        """
         df = GetData.to_dataframe(response)
         log("serialized to dataframe: OK", LogLevel.INFO)
         return df

src/api_to_dataframe/utils/logger.py

@@ -11,13 +11,12 @@ class LogLevel(Enum):
 # Configure logging once at the start of your program
 logging.basicConfig(
     encoding="utf-8",
-    format="%(asctime)s :: %(levelname)s :: %(message)s",
+    format="%(asctime)s :: api-to-dataframe[%(levelname)s] :: %(message)s",
     datefmt="%Y-%m-%d %H:%M:%S %Z",
-    level=logging.DEBUG,
+    level=logging.INFO,
 )
 
 
 def log(message: str, level: LogLevel):
     logger = logging.getLogger("api-to-dataframe")
     logger.log(level.value, message)
-    

tests/test_controller_client_builder.py

@@ -66,8 +66,8 @@ def test_constructor_with_param(client_setup):  # pylint: disable=redefined-oute
 
 def test_response_to_json(client_setup):  # pylint: disable=redefined-outer-name
     new_client = client_setup
-    response = new_client._get_raw_api_data()  # pylint: disable=protected-access
-    assert isinstance(response, requests.Response)
+    response = new_client.get_api_data()  # pylint: disable=protected-access
+    assert isinstance(response, dict)
 
 
 def test_to_dataframe(response_setup):  # pylint: disable=redefined-outer-name