garf-core 0.0.5__py3-none-any.whl → 0.0.7__py3-none-any.whl

garf_core/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.0.5'
+__version__ = '0.0.7'

garf_core/api_clients.py

@@ -19,6 +19,7 @@ import abc
 import dataclasses
 from collections.abc import Sequence
 
+import requests
 from typing_extensions import override
 
 
@@ -34,16 +35,40 @@ class GarfApiResponse:
   results: list
 
 
+class GarfApiError(Exception):
+  """API specific exception."""
+
+
 class BaseClient(abc.ABC):
   """Base API client class."""
 
   @abc.abstractmethod
   def get_response(
-    self, request: GarfApiRequest = GarfApiRequest()
+    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
   ) -> GarfApiResponse:
     """Method for getting response."""
 
 
+class RestApiClient(BaseClient):
+  """Specifies REST client."""
+
+  OK = 200
+
+  def __init__(self, endpoint: str, **kwargs: str) -> None:
+    """Initializes RestApiClient."""
+    self.endpoint = endpoint
+    self.query_args = kwargs
+
+  @override
+  def get_response(
+    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
+  ) -> GarfApiResponse:
+    response = requests.get(f'{self.endpoint}/{request.resource_name}')
+    if response.status_code == self.OK:
+      return GarfApiResponse(response.json())
+    raise GarfApiError('Failed to get data from API')
+
+
 class FakeApiClient(BaseClient):
   """Fake class for specifying API client."""
 

garf_core/report.py

@@ -183,6 +183,18 @@ class GarfReport:
         output[key] = value
     return output
 
+  def to_polars(self) -> 'pl.DataFrame':
+    try:
+      import polars as pl
+    except ImportError as e:
+      raise ImportError(
+        'Please install garf-io with Polars support '
+        '- `pip install garf-io[polars]`'
+      ) from e
+    return pl.DataFrame(
+      data=self.results, schema=self.column_names, orient='row'
+    )
+
   def to_pandas(self) -> 'pd.DataFrame':
     """Converts report to Pandas dataframe.
 
@@ -196,8 +208,8 @@ class GarfReport:
       import pandas as pd
     except ImportError as e:
       raise ImportError(
-        'Please install google-ads-api-report-fetcher with Pandas support '
-        '- `pip install google-ads-api-report-fetcher[pandas]`'
+        'Please install garf-io with Pandas support '
+        '- `pip install garf-io[pandas]`'
       ) from e
     return pd.DataFrame(data=self.results, columns=self.column_names)
 
@@ -385,6 +397,30 @@ class GarfReport:
       and other.results_placeholder,
     )
 
+  @classmethod
+  def from_polars(cls, df: 'pl.DataFrame') -> GarfReport:
+    """Builds GarfReport from polars dataframe.
+
+    Args:
+        df: Polars dataframe to build report from.
+
+    Returns:
+        Report build from dataframe data and columns.
+
+    Raises:
+        ImportError: If polars library not installed.
+    """
+    try:
+      import polars as pl
+    except ImportError as e:
+      raise ImportError(
+        'Please install garf-io with Polars support '
+        '- `pip install garf-io[polars]`'
+      ) from e
+    return cls(
+      results=df.to_numpy().tolist(), column_names=list(df.schema.keys())
+    )
+
   @classmethod
   def from_pandas(cls, df: 'pd.DataFrame') -> GarfReport:
     """Builds GarfReport from pandas dataframe.
@@ -402,8 +438,8 @@ class GarfReport:
       import pandas as pd
     except ImportError as e:
       raise ImportError(
-        'Please install google-ads-api-report-fetcher with Pandas support '
-        '- `pip install google-ads-api-report-fetcher[pandas]`'
+        'Please install garf-io with Pandas support '
+        '- `pip install garf-io[pandas]`'
       ) from e
     return cls(results=df.values.tolist(), column_names=list(df.columns.values))
 

garf_core/report_fetcher.py

@@ -11,9 +11,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Module for getting data from Ads API based on a query.
+"""Module for getting data from API based on a query.
 
-AdsReportFetcher performs fetching data from Ads API, parsing it
+ApiReportFetcher performs fetching data from API, parsing it
   and returning GarfReport.
 """
 # pylint: disable=C0330, g-bad-import-order, g-multiple-import
@@ -34,25 +34,27 @@ logger = logging.getLogger(__name__)
 
 
 class ApiReportFetcher:
-  """Class responsible for getting data from Ads API.
+  """Class responsible for getting data from report API.
 
   Attributes:
-      api_client: a client used for connecting to Ads API.
+      api_client: a client used for connecting to API.
   """
 
   def __init__(
     self,
     api_client: api_clients.BaseApiClient,
     parser: parsers.BaseParser = parsers.ListParser,
+    **kwargs: str,
   ) -> None:
-    """Instantiates AdsReportFetcher based on provided api client.
+    """Instantiates ApiReportFetcher based on provided api client.
 
     Args:
-      api_client: Instantiated GoogleAdsClient or GoogleAdsApiClient.
-      parser: Parser.
+      api_client: Instantiated api client.
+      parser: Type of parser to convert API response.
     """
     self.api_client = api_client
     self.parser = parser()
+    self.query_args = kwargs
 
   async def afetch(
     self,
@@ -60,10 +62,10 @@ class ApiReportFetcher:
     args: dict[str, Any] | None = None,
     **kwargs: str,
   ) -> report.GarfReport:
-    """Asynchronously fetches data from Ads API based on query_specification.
+    """Asynchronously fetches data from API based on query_specification.
 
     Args:
-        query_specification: Query text that will be passed to Ads API
+        query_specification: Query text that will be passed to API
             alongside column_names, customizers and virtual columns.
         args: Arguments that need to be passed to the query.
 
@@ -78,10 +80,10 @@ class ApiReportFetcher:
     args: dict[str, Any] | None = None,
     **kwargs: str,
   ) -> report.GarfReport:
-    """Fetches data from Ads API based on query_specification.
+    """Fetches data from API based on query_specification.
 
     Args:
-        query_specification: Query text that will be passed to Ads API
+        query_specification: Query text that will be passed to API
             alongside column_names, customizers and virtual columns.
         args: Arguments that need to be passed to the query.
 
@@ -90,7 +92,7 @@ class ApiReportFetcher:
 
     Raises:
         GarfExecutorException:
-            When customer_ids are not provided or Ads API returned error.
+            When customer_ids are not provided or API returned error.
     """
     if not isinstance(query_specification, query_editor.QuerySpecification):
       query_specification = query_editor.QuerySpecification(
@@ -103,3 +105,26 @@ class ApiReportFetcher:
     return report.GarfReport(
       results=parsed_response, column_names=query.column_names
     )
+
+
+class RestApiReportFetcher(ApiReportFetcher):
+  """Fetches data from an REST API endpoint.
+
+  Attributes:
+    api_client: Initialized RestApiClient.
+    parser: Type of parser to convert API response.
+  """
+
+  def __init__(
+    self,
+    endpoint: str,
+    parser: parsers.BaseParser = parsers.DictParser,
+  ) -> None:
+    """Instantiates RestApiReportFetcher.
+
+    Args:
+      endpoint: URL of API endpoint.
+      parser: Type of parser to convert API response.
+    """
+    self.api_client = api_clients.RestApiClient(endpoint)
+    self.parser = parser()

garf_core-0.0.7.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.2
+Name: garf-core
+Version: 0.0.7
+Summary: Abstracts fetching data from API based on provided SQL-like query.
+Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
+License: Apache 2.0
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: python-dateutil
+Requires-Dist: jinja2==3.1.4
+Requires-Dist: typing-extensions
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == "pandas"
+Provides-Extra: polars
+Requires-Dist: polars; extra == "polars"
+Provides-Extra: all
+Requires-Dist: garf-core[pandas,polars]; extra == "all"
+
+# garf-core - Unified approach for interacting with reporting APIs.
+
+[![PyPI](https://img.shields.io/pypi/v/garf-core?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-core)
+[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-core?logo=pypi)](https://pypi.org/project/garf-core/)
+
+
+`garf-core` contains the base abstractions are used by an implementation for a concrete reporting API.
+
+These abstractions are designed to be as modular and simple as possible:
+
+* `BaseApiClient` - an interface for connecting to APIs.
+* `BaseQuery` - encapsulates SQL-like request.
+* `QuerySpecification` - parsed SQL-query into various elements.
+* `BaseParser` - an interface to parse results from the API. Have a couple of default implementations:
+    * `ListParser` - returns results from API as a raw list.
+    * `DictParser` - returns results from API as a formatted dict.
+        * `NumericDictParser` - returns results from API as a formatted dict with converted numeric values.
+* `GarfReport` - contains data from API in a format that is easy to write and interact with.
+* `ApiReportFetcher` - responsible for fetching and parsing data from reporting API.
+
+## Installation
+
+`pip install garf-core`

garf_core-0.0.7.dist-info/RECORD

@@ -0,0 +1,13 @@
+garf_core/__init__.py,sha256=YXfq75YjkKDgNZM8YGRyE5aGGLa3MUVQasljixjp-70,598
+garf_core/api_clients.py,sha256=FKmwts_QBV_E4aTmrnsZtow0CmSExLibfeSkMSrudU0,2235
+garf_core/base_query.py,sha256=uEhKP56wcFtMiSwYOxoZ0q7OEvURGVOeRdpSYjxWLho,1201
+garf_core/exceptions.py,sha256=4qvNN-8GqbbVsrLKxJwBeX1FUtWpKbhUWyvm7anD3iE,1916
+garf_core/parsers.py,sha256=Y4wwpDXRZky7LBTBklvzk-aDNxgRL5RJg52rSdH5t9Q,2928
+garf_core/query_editor.py,sha256=EzwjFnbje-RcP9VwWQwzCpy8lipt4tph3Kv6q5Lly5o,15994
+garf_core/report.py,sha256=xlkZ44cdT_uGENuNeGwy69h7XLtwjdUjyPw3S1m-zc8,17852
+garf_core/report_fetcher.py,sha256=g2bmqq8m3XxrWh1tDJ7ZO6iCys34mX8Dm55ZaT_36TI,3813
+garf_core-0.0.7.dist-info/METADATA,sha256=gn0SYdh11jDgZKJJW4m1bD6TfYM90mbq-lqOWm7kQR4,2334
+garf_core-0.0.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+garf_core-0.0.7.dist-info/entry_points.txt,sha256=ODxSZXwWEIXQAjRwBQsBJ6GYw8oPK6DYTo0oDVkKCpo,39
+garf_core-0.0.7.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
+garf_core-0.0.7.dist-info/RECORD,,

garf_core-0.0.7.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[garf]
+rest = garf_core.report_fetcher

garf_core-0.0.5.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.2
-Name: garf-core
-Version: 0.0.5
-Summary: Abstracts fetching data from API based on provided SQL-like query.
-Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
-License: Apache 2.0
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: python-dateutil
-Requires-Dist: jinja2==3.1.4
-Requires-Dist: typing-extensions
-Provides-Extra: pandas
-Requires-Dist: pandas; extra == "pandas"
-Provides-Extra: all
-Requires-Dist: garf-core[pandas]; extra == "all"
-
-# gaarf-core - Unified approach for interacting with reporting APIs.

garf_core-0.0.5.dist-info/RECORD

@@ -1,12 +0,0 @@
-garf_core/__init__.py,sha256=Te0VIlL1MdNgrZ3wJdVePlSHb4Q-0-2KtcuhQp10jOQ,598
-garf_core/api_clients.py,sha256=sBiOfPllrSewV6Ul4uaHhdmgTHQ_l5M7sZHW1z4kNik,1568
-garf_core/base_query.py,sha256=uEhKP56wcFtMiSwYOxoZ0q7OEvURGVOeRdpSYjxWLho,1201
-garf_core/exceptions.py,sha256=4qvNN-8GqbbVsrLKxJwBeX1FUtWpKbhUWyvm7anD3iE,1916
-garf_core/parsers.py,sha256=Y4wwpDXRZky7LBTBklvzk-aDNxgRL5RJg52rSdH5t9Q,2928
-garf_core/query_editor.py,sha256=EzwjFnbje-RcP9VwWQwzCpy8lipt4tph3Kv6q5Lly5o,15994
-garf_core/report.py,sha256=-wz3c4k6Gtxs1jdqC0aSK61ziulxV1cGTl55E8o26bs,16980
-garf_core/report_fetcher.py,sha256=RazwzI8n3e4oVhFUEGshzwaGG0EHIYJgHOleuAeNEto,3231
-garf_core-0.0.5.dist-info/METADATA,sha256=_stbiUxOKv99mdf9EHHw8r5T-QeFKj9wpfAji2SRwQ0,1115
-garf_core-0.0.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-garf_core-0.0.5.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
-garf_core-0.0.5.dist-info/RECORD,,