api-to-dataframe 1.2.3__tar.gz → 1.3.0__tar.gz

{api_to_dataframe-1.2.3 → api_to_dataframe-1.3.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: api-to-dataframe
-Version: 1.2.3
+Version: 1.3.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
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.8
+Requires-Dist: logging (>=0.4.9.6,<0.5.0.0)
 Requires-Dist: pandas (>=2.2.2,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Project-URL: Documentation, https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/README.md
@@ -46,7 +47,7 @@ Python library that simplifies obtaining data from API endpoints by converting t
 ![Python](https://img.shields.io/badge/-Python-05122A?style=flat&logo=python)&nbsp;
 ![Docker](https://img.shields.io/badge/-Docker-05122A?style=flat&logo=docker)&nbsp;
 ![Poetry](https://img.shields.io/badge/-Poetry-05122A?style=flat&logo=poetry)&nbsp;
-![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions)&nbsp; 
+![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions)&nbsp;
 ![CodeCov](https://img.shields.io/badge/-CodeCov-05122A?style=flat&logo=codecov)&nbsp;
 ![pypi](https://img.shields.io/badge/-pypi-05122A?style=flat&logo=pypi)&nbsp;
 ![pandas](https://img.shields.io/badge/-pandas-05122A?style=flat&logo=pandas)&nbsp;
@@ -76,29 +77,28 @@ from api_to_dataframe import ClientBuilder, RetryStrategies
 # Create a client for simple ingest data from API (timeout 1 second)
 client = ClientBuilder(endpoint="https://api.example.com")
 
-# if you can define timeout with LinearStrategy and set headers:
+# if you can define timeout with LINEAR_RETRY_STRATEGY and set headers:
 headers = {
     "application_name": "api_to_dataframe"
 }
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,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:
-    
+NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
 """
 
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,connection_timeout=10
                         ,headers=headers
                         ,retries=5
                         ,initial_delay=10)
- 
 
-### timeout, retry_strategy and headers are opcionals parameters 
+
+### timeout, retry_strategy and headers are opcionals parameters
 
 # Get data from the API
 data = client.get_api_data()

{api_to_dataframe-1.2.3 → api_to_dataframe-1.3.0}/README.md

@@ -19,7 +19,7 @@ Python library that simplifies obtaining data from API endpoints by converting t
 ![Python](https://img.shields.io/badge/-Python-05122A?style=flat&logo=python) 
 ![Docker](https://img.shields.io/badge/-Docker-05122A?style=flat&logo=docker) 
 ![Poetry](https://img.shields.io/badge/-Poetry-05122A?style=flat&logo=poetry) 
-![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions)  
+![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions) 
 ![CodeCov](https://img.shields.io/badge/-CodeCov-05122A?style=flat&logo=codecov) 
 ![pypi](https://img.shields.io/badge/-pypi-05122A?style=flat&logo=pypi) 
 ![pandas](https://img.shields.io/badge/-pandas-05122A?style=flat&logo=pandas) 
@@ -49,29 +49,28 @@ from api_to_dataframe import ClientBuilder, RetryStrategies
 # Create a client for simple ingest data from API (timeout 1 second)
 client = ClientBuilder(endpoint="https://api.example.com")
 
-# if you can define timeout with LinearStrategy and set headers:
+# if you can define timeout with LINEAR_RETRY_STRATEGY and set headers:
 headers = {
     "application_name": "api_to_dataframe"
 }
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,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:
-    
+NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
 """
 
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,connection_timeout=10
                         ,headers=headers
                         ,retries=5
                         ,initial_delay=10)
- 
 
-### timeout, retry_strategy and headers are opcionals parameters 
+
+### timeout, retry_strategy and headers are opcionals parameters
 
 # Get data from the API
 data = client.get_api_data()

{api_to_dataframe-1.2.3 → api_to_dataframe-1.3.0}/pyproject.toml

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.2.3"
+version = "1.3.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 :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
@@ -26,12 +26,15 @@ Repository = "https://github.com/IvanildoBarauna/api-to-dataframe"
 python = "^3.9"
 pandas = "^2.2.2"
 requests = "^2.32.3"
+logging = "^0.4.9.6"
 
 [tool.poetry.group.dev.dependencies]
 poetry-dynamic-versioning = "^1.3.0"
 pytest = "^8.2.2"
 coverage = "^7.5.3"
 responses = "^0.25.3"
+pylint = "^3.2.5"
+black = "^24.4.2"
 
 
 [build-system]
@@ -46,3 +49,11 @@ include = ["api_to_dataframe*"]
 [tool.poetry-dynamic-versioning]
 enable = true
 versioning = "semantic"
+
+[tool.pylint.'MESSAGES CONTROL']
+disable = [
+    "C0114", # missing-module-docstring
+    "C0116", # missing-function-docstring
+    "C0115", # missing-class-docstring
+    "R0903", # too-few-public-methods
+]

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

@@ -0,0 +1,84 @@
+from api_to_dataframe.models.retainer import retry_strategies, Strategies
+from api_to_dataframe.models.get_data import GetData
+from api_to_dataframe.utils.logger import log, LogLevel
+
+
+class ClientBuilder:
+    def __init__(  # pylint: disable=too-many-arguments
+        self,
+        endpoint: str,
+        headers: dict = None,
+        retry_strategy: Strategies = Strategies.NO_RETRY_STRATEGY,
+        retries: int = 3,
+        initial_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): Defaults to Strategies.NoRetryStrategy.
+            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.
+
+        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 == "":
+            log("endpoint param is mandatory", LogLevel.ERROR)
+            raise ValueError
+        if not isinstance(retries, int) or retries < 0:
+            log("retries must be a non-negative integer", LogLevel.ERROR)
+            raise ValueError
+        if not isinstance(initial_delay, int) or initial_delay < 0:
+            log("delay must be a non-negative integer", LogLevel.ERROR)
+            raise ValueError
+        if not isinstance(connection_timeout, int) or connection_timeout < 0:
+            log("connection_timeout must be a non-negative integer", LogLevel.ERROR)
+            raise ValueError
+
+        self.endpoint = endpoint
+        self.retry_strategy = retry_strategy
+        self.connection_timeout = connection_timeout
+        self.headers = headers
+        self.retries = retries
+        self.delay = initial_delay
+
+    @retry_strategies
+    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)
+        log("serialized to dataframe: OK", LogLevel.INFO)
+        return df

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

@@ -0,0 +1,29 @@
+import requests
+import pandas as pd
+
+from api_to_dataframe.utils.logger import log, LogLevel
+
+
+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()
+        log("get_response: ok", LogLevel.INFO)
+        return response
+
+    @staticmethod
+    def to_dataframe(response):
+        try:
+            df = pd.DataFrame(response)
+        except Exception as err:
+            log(f"Error serializing to dataframe: {err}", LogLevel.ERROR)
+            raise TypeError(
+                f"Invalid response for transform in dataframe: {err}"
+            ) from err
+
+        if df.empty:
+            log("DataFrame is empty", LogLevel.ERROR)
+            raise ValueError("::: DataFrame is empty :::")
+
+        return df

api_to_dataframe-1.3.0/src/api_to_dataframe/models/retainer.py

@@ -0,0 +1,41 @@
+import time
+from enum import Enum
+from requests.exceptions import RequestException
+from api_to_dataframe.utils.logger import log, LogLevel
+
+
+class Strategies(Enum):
+    NO_RETRY_STRATEGY = 0
+    LINEAR_RETRY_STRATEGY = 1
+    EXPONENTIAL_RETRY_STRATEGY = 2
+
+
+def retry_strategies(func):
+    def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
+        retry_number = 0
+        while retry_number < args[0].retries:
+            try:
+                log(
+                    f"Trying for the {retry_number + 1} of {args[0].retries} retries. "
+                    f"Using {args[0].retry_strategy}",
+                    LogLevel.INFO,
+                )
+                return func(*args, **kwargs)
+            except RequestException as e:
+                retry_number += 1
+
+                if args[0].retry_strategy == Strategies.NO_RETRY_STRATEGY:
+                    raise e
+                if 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 * 2**retry_number)
+
+                if retry_number == args[0].retries:
+                    log(
+                        f"Failed after {retry_number} retries using {args[0].retry_strategy}",
+                        LogLevel.ERROR,
+                    )
+                    raise e
+
+    return wrapper

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

@@ -0,0 +1,27 @@
+import logging
+from enum import Enum
+
+
+class LogLevel(Enum):
+    INFO = logging.INFO
+    WARNING = logging.WARNING
+    ERROR = logging.ERROR
+
+
+# Configure logging once at the start of your program
+logging.basicConfig(
+    encoding="utf-8",
+    format="%(asctime)s :: %(levelname)s :: %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S %Z",
+    level=logging.DEBUG,
+)
+
+
+def log(message: str, level: LogLevel):
+    logger = logging.getLogger("api-to-dataframe")
+    logger.log(level.value, message)
+
+
+log("This is an info message", LogLevel.INFO)
+log("This is a warning message", LogLevel.WARNING)
+log("This is an error message", LogLevel.ERROR)

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

@@ -1,76 +0,0 @@
-from api_to_dataframe.models.retainer import RetryStrategies, 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,
-                 initial_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(initial_delay, int) or initial_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 = initial_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.3/src/api_to_dataframe/models/get_data.py

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

@@ -1,30 +0,0 @@
-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