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

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: api-to-dataframe
-Version: 1.1.0
+Version: 1.2.0
 Summary: A package to convert API responses to pandas dataframe
 Home-page: https://github.com/IvanildoBarauna/api-to-dataframe
 License: MIT
 Author: IvanildoBarauna
 Author-email: ivanildo.jnr@outlook.com
 Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -70,24 +70,37 @@ To install the package using poetry, use the following command:
 poetry add api-to-dataframe
 ```
 
-## How to use it
+## User Guide
 
 ``` python
 ## Importing library
 from api_to_dataframe import ClientBuilder, RetryStrategies
 
-# Create a client for simple ingest data from API (timeout 5 seconds)
+# Create a client for simple ingest data from API (timeout 1 second)
 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:
+# if you can define timeout with LinearStrategy and set headers:
 headers = {
     "application_name": "api_to_dataframe"
 }
 client = ClientBuilder(endpoint="https://api.example.com"
                         ,retry_strategy=RetryStrategies.LinearStrategy
-                        ,timeout=10
+                        ,connection_timeout=2
                         ,headers=headers)
 
+"""
+    NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually, like this:
+    
+"""
+
+client = ClientBuilder(endpoint="https://api.example.com"
+                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,connection_timeout=10
+                        ,headers=headers
+                        ,retries=5
+                        ,delay=10)
+ 
+
 ### timeout, retry_strategy and headers are opcionals parameters 
 
 # Get data from the API

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

@@ -45,24 +45,37 @@ To install the package using poetry, use the following command:
 poetry add api-to-dataframe
 ```
 
-## How to use it
+## User Guide
 
 ``` python
 ## Importing library
 from api_to_dataframe import ClientBuilder, RetryStrategies
 
-# Create a client for simple ingest data from API (timeout 5 seconds)
+# Create a client for simple ingest data from API (timeout 1 second)
 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:
+# if you can define timeout with LinearStrategy and set headers:
 headers = {
     "application_name": "api_to_dataframe"
 }
 client = ClientBuilder(endpoint="https://api.example.com"
                         ,retry_strategy=RetryStrategies.LinearStrategy
-                        ,timeout=10
+                        ,connection_timeout=2
                         ,headers=headers)
 
+"""
+    NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually, like this:
+    
+"""
+
+client = ClientBuilder(endpoint="https://api.example.com"
+                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,connection_timeout=10
+                        ,headers=headers
+                        ,retries=5
+                        ,delay=10)
+ 
+
 ### timeout, retry_strategy and headers are opcionals parameters 
 
 # Get data from the API

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

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.1.0"
+version = "1.2.0"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
 readme = "README.md"
 license = "MIT"
 classifiers=[
-    "Development Status :: 2 - Pre-Alpha",
+    "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",

api_to_dataframe-1.2.0/src/api_to_dataframe/__init__.py

@@ -0,0 +1,2 @@
+from .controller.client_builder import ClientBuilder
+from .models.retainer import Strategies as RetryStrategies

api_to_dataframe-1.2.0/src/api_to_dataframe/controller/client_builder.py

@@ -0,0 +1,77 @@
+from api_to_dataframe.models.retainer import RetryStrategies
+from api_to_dataframe.models.retainer import Strategies
+from api_to_dataframe.models.get_data import GetData
+
+
+class ClientBuilder:
+    def __init__(self,
+                 endpoint: str,
+                 headers: dict = None,
+                 retry_strategy: Strategies = Strategies.NoRetryStrategy,
+                 retries: int = 3,
+                 delay: int = 1,
+                 connection_timeout: int = 1):
+
+        """
+          Initializes the ClientBuilder object.
+
+          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): The strategy to use for retrying failed requests. Defaults to Strategies.NoRetryStrategy.
+              retries (int, optional): The number of times to retry a failed request. Defaults to 3.
+              delay (int, optional): The delay between retries in seconds. Defaults to 1.
+              connection_timeout (int, optional): The timeout for the connection in seconds. Defaults to 2.
+
+          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 connection_timeout is not a non-negative integer.
+        """
+
+        if headers is None:
+            headers = {}
+        if endpoint == "":
+            raise ValueError("::: endpoint param is mandatory :::")
+        if not isinstance(retries, int) or retries < 0:
+            raise ValueError("retries must be a non-negative integer")
+        if not isinstance(delay, int) or delay < 0:
+            raise ValueError("delay must be a non-negative integer")
+        if not isinstance(connection_timeout, int) or connection_timeout < 0:
+            raise ValueError("connection_timeout must be a non-negative integer")
+
+        self.endpoint = endpoint
+        self.retry_strategy = retry_strategy
+        self.connection_timeout = connection_timeout
+        self.headers = headers
+        self.retries = retries
+        self.delay = delay
+
+    @RetryStrategies
+    def get_api_data(self):
+        """
+        Retrieves data from the API using the defined endpoint and retry strategy.
+
+        Returns:
+            dict: The response from the API.
+        """
+        response = GetData.get_response(
+            endpoint=self.endpoint,
+            headers=self.headers,
+            connection_timeout=self.connection_timeout
+        )
+        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):
+        df = GetData.to_dataframe(response)
+        return df

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

@@ -0,0 +1,30 @@
+import requests
+from requests.exceptions import HTTPError, Timeout
+import pandas as pd
+
+# from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
+from api_to_dataframe.models.retainer import RetryStrategies
+
+
+class GetData:
+    @staticmethod
+    def get_response(endpoint: str,
+                     headers: dict,
+                     connection_timeout: int):
+
+
+
+        response = requests.get(endpoint, timeout=connection_timeout, headers=headers)
+        response.raise_for_status()
+        return response
+    @staticmethod
+    def to_dataframe(response):
+        try:
+            df = pd.DataFrame(response)
+        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.2.0/src/api_to_dataframe/models/retainer.py

@@ -0,0 +1,30 @@
+import time
+from enum import Enum
+
+
+class Strategies(Enum):
+    NoRetryStrategy = 0
+    LinearRetryStrategy = 1
+    ExponentialRetryStrategy = 2
+
+
+def RetryStrategies(func):
+    def wrapper(*args, **kwargs):
+        retry_number = 0
+        while retry_number < args[0].retries:
+            try:
+                return func(*args, **kwargs)
+            except Exception as e:
+                retry_number += 1
+
+                if args[0].retry_strategy == Strategies.NoRetryStrategy:
+                    raise e
+                elif args[0].retry_strategy == Strategies.LinearRetryStrategy:
+                    time.sleep(args[0].delay)
+                elif args[0].retry_strategy == Strategies.ExponentialRetryStrategy:
+                    time.sleep(args[0].delay * 2 ** retry_number)
+
+                if retry_number == args[0].retries:
+                    print(f"Failed after {retry_number} retries using {args[0].retry_strategy}")
+                    raise e
+    return wrapper

api_to_dataframe-1.1.0/src/api_to_dataframe/__init__.py

@@ -1,2 +0,0 @@
-from .controller.client_builder import ClientBuilder
-from .common.utils.retry_strategies import RetryStrategies

api_to_dataframe-1.1.0/src/api_to_dataframe/common/utils/retry_strategies.py

@@ -1,9 +0,0 @@
-from enum import Enum
-
-
-class RetryStrategies(Enum):
-    NoRetryStrategy = 0
-    LinearStrategy = 1
-    ExponentialStrategy = 2
-    CustomStrategy = 3
-

api_to_dataframe-1.1.0/src/api_to_dataframe/controller/client_builder.py

@@ -1,52 +0,0 @@
-from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
-from api_to_dataframe.models.get_data import GetData
-
-
-class ClientBuilder:
-    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.
-        """
-        if endpoint == "":
-            raise ValueError("::: endpoint param is mandatory :::")
-        else:
-            self.endpoint = endpoint
-            self.retry_strategy = retry_strategy
-            self.timeout = timeout
-            self.headers = headers
-
-    def get_api_data(self):
-        """
-        Retrieves data from the API using the defined endpoint and retry strategy.
-
-        Returns:
-            dict: The response from the API.
-        """
-        response = GetData.get_response(self.endpoint, self.headers, self.retry_strategy, self.timeout)
-        return response
-
-    @staticmethod
-    def api_to_dataframe(response: dict):
-        """
-        Converts the API response into a DataFrame.
-
-        Args:
-            response (dict): The response from the API.
-
-        Returns:
-            DataFrame: The data converted into a DataFrame.
-        """
-        df = GetData.to_dataframe(response)
-        return df

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

@@ -1,36 +0,0 @@
-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.1.0/src/api_to_dataframe/models/retainer.py

@@ -1,15 +0,0 @@
-from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
-
-
-class Retainer:
-    @staticmethod
-    def strategy(retry_strategy: RetryStrategies = RetryStrategies.NoRetryStrategy):
-        if retry_strategy == RetryStrategies.NoRetryStrategy:
-            print("::: NoRetryStrategy :::")
-        elif retry_strategy == RetryStrategies.LinearStrategy:
-            print("::: LinearStrategy :::")
-        elif retry_strategy == RetryStrategies.ExponentialStrategy:
-            print("::: ExponentialStrategy :::")
-        elif retry_strategy == RetryStrategies.CustomStrategy:
-            print("::: CustomStrategy :::")
-