api-to-dataframe 1.0.2__tar.gz → 1.1.0__tar.gz

{api_to_dataframe-1.0.2 → api_to_dataframe-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: api-to-dataframe
-Version: 1.0.2
+Version: 1.1.0
 Summary: A package to convert API responses to pandas dataframe
 Home-page: https://github.com/IvanildoBarauna/api-to-dataframe
 License: MIT
@@ -76,10 +76,19 @@ poetry add api-to-dataframe
 ## Importing library
 from api_to_dataframe import ClientBuilder, RetryStrategies
 
-# Create a client for the API without retry strategy
-client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.NoRetryStrategy)
-# or with LinearStrategy (In development, actually don't nothing)
-client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.LinearStrategy)
+# Create a client for simple ingest data from API (timeout 5 seconds)
+client = ClientBuilder(endpoint="https://api.example.com")
+
+# if you can define timeout, use: (default is 5 seconds), with LinearStrategy (In development, actually don't nothing) and set headers:
+headers = {
+    "application_name": "api_to_dataframe"
+}
+client = ClientBuilder(endpoint="https://api.example.com"
+                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,timeout=10
+                        ,headers=headers)
+
+### timeout, retry_strategy and headers are opcionals parameters 
 
 # Get data from the API
 data = client.get_api_data()

{api_to_dataframe-1.0.2 → api_to_dataframe-1.1.0}/README.md

@@ -51,10 +51,19 @@ poetry add api-to-dataframe
 ## Importing library
 from api_to_dataframe import ClientBuilder, RetryStrategies
 
-# Create a client for the API without retry strategy
-client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.NoRetryStrategy)
-# or with LinearStrategy (In development, actually don't nothing)
-client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.LinearStrategy)
+# Create a client for simple ingest data from API (timeout 5 seconds)
+client = ClientBuilder(endpoint="https://api.example.com")
+
+# if you can define timeout, use: (default is 5 seconds), with LinearStrategy (In development, actually don't nothing) and set headers:
+headers = {
+    "application_name": "api_to_dataframe"
+}
+client = ClientBuilder(endpoint="https://api.example.com"
+                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,timeout=10
+                        ,headers=headers)
+
+### timeout, retry_strategy and headers are opcionals parameters 
 
 # Get data from the API
 data = client.get_api_data()

{api_to_dataframe-1.0.2 → api_to_dataframe-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.0.2"
+version = "1.1.0"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
 readme = "README.md"
@@ -22,24 +22,27 @@ Homepage = "https://github.com/IvanildoBarauna/api-to-dataframe"
 Documentation = "https://github.com/IvanildoBarauna/api-to-dataframe#readme"
 Issues = "https://github.com/IvanildoBarauna/api-to-dataframe/issues"
 
-[tool.setuptools.packages.find]
-where = ["src"]
-include = ["api_to_dataframe*"]
+[tool.poetry.dependencies]
+python = "^3.9"
+pandas = "^2.2.2"
+requests = "^2.32.3"
 
 [tool.poetry.group.dev.dependencies]
 poetry-dynamic-versioning = "^1.3.0"
 pytest = "^8.2.2"
 coverage = "^7.5.3"
+responses = "^0.25.3"
 
-[tool.poetry.dependencies]
-python = "^3.9"
-pandas = "^2.2.2"
-requests = "^2.32.3"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.setuptools.packages.find]
+where = ["src/"]
+include = ["api_to_dataframe*"]
+
+
 [tool.poetry-dynamic-versioning]
 enable = true
 versioning = "semantic"

{api_to_dataframe-1.0.2 → api_to_dataframe-1.1.0}/src/api_to_dataframe/__init__.py

@@ -1,4 +1,2 @@
 from .controller.client_builder import ClientBuilder
 from .common.utils.retry_strategies import RetryStrategies
-
-__all__ = ['ClientBuilder', 'RetryStrategies']

{api_to_dataframe-1.0.2 → api_to_dataframe-1.1.0}/src/api_to_dataframe/controller/client_builder.py

@@ -3,21 +3,18 @@ from api_to_dataframe.models.get_data import GetData
 
 
 class ClientBuilder:
-    """
-    Builder for creating clients that interact with an API endpoint and return data.
-
-    Attributes:
-        endpoint (str): The API endpoint to be accessed.
-        retry_strategy (RetryStrategies): The retry strategy for the request. Default is NoRetryStrategy.
-    """
-
-    def __init__(self, endpoint: str, retry_strategy: RetryStrategies = RetryStrategies.NoRetryStrategy):
+    def __init__(self,
+                 endpoint: str,
+                 headers: dict = {},
+                 retry_strategy: RetryStrategies = RetryStrategies.NoRetryStrategy,
+                 timeout: int = 5):
         """
         Initializes an instance of ClientBuilder.
 
         Args:
             endpoint (str): The API endpoint to be accessed.
             retry_strategy (RetryStrategies, optional): The retry strategy for the request. Default is NoRetryStrategy.
+            timeout (int, optional): The timeout for the request. Default is 5 seconds.
 
         Raises:
             ValueError: If the endpoint is empty.
@@ -27,6 +24,8 @@ class ClientBuilder:
         else:
             self.endpoint = endpoint
             self.retry_strategy = retry_strategy
+            self.timeout = timeout
+            self.headers = headers
 
     def get_api_data(self):
         """
@@ -35,7 +34,7 @@ class ClientBuilder:
         Returns:
             dict: The response from the API.
         """
-        response = GetData.get_response(self.endpoint, self.retry_strategy)
+        response = GetData.get_response(self.endpoint, self.headers, self.retry_strategy, self.timeout)
         return response
 
     @staticmethod

api_to_dataframe-1.1.0/src/api_to_dataframe/models/get_data.py

@@ -0,0 +1,36 @@
+import requests
+from requests.exceptions import HTTPError, Timeout, RequestException
+import pandas as pd
+
+from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
+
+
+class GetData:
+    @staticmethod
+    def get_response(endpoint: str,
+                     headers: dict,
+                     retry_strategies: RetryStrategies,
+                     timeout: int):
+        try:
+            response = requests.get(endpoint, timeout=timeout, headers=headers)
+            response.raise_for_status()
+        except HTTPError as http_err:
+            print(f'HTTP error occurred: {http_err}')
+            raise http_err
+        except Timeout as timeout_err:
+            print(f'Timeout error occurred: {timeout_err}')
+            raise timeout_err
+        else:
+            return response
+
+    @staticmethod
+    def to_dataframe(response):
+        try:
+            df = pd.DataFrame(response.json())
+        except Exception as err:
+            raise TypeError(f"Invalid response for transform in dataframe: {err}")
+
+        if df.empty:
+            raise ValueError("::: DataFrame is empty :::")
+        else:
+            return df

api_to_dataframe-1.0.2/src/api_to_dataframe/models/get_data.py

@@ -1,24 +0,0 @@
-import requests
-import pandas as pd
-
-from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
-
-
-class GetData:
-    @staticmethod
-    def get_response(endpoint: str, RetryStrategies: RetryStrategies):
-        response = requests.get(endpoint)
-
-        if response.ok:
-            return response.json()
-        else:
-            raise ConnectionError(response.status_code)
-
-    @staticmethod
-    def to_dataframe(response):
-        df = pd.DataFrame(response)
-        if df.empty:
-            raise ValueError("::: DataFrame is empty :::")
-        else:
-            return df
-