garf-executors 0.0.1__tar.gz → 0.0.3__tar.gz

garf_executors-0.0.3/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.2
+Name: garf-executors
+Version: 0.0.3
+Summary: Executes queries against API and writes data to local/remote storage.
+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: garf-core
+Requires-Dist: garf-io
+Provides-Extra: bq
+Requires-Dist: garf-io[bq]; extra == "bq"
+Requires-Dist: pandas; extra == "bq"
+Provides-Extra: sql
+Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
+Requires-Dist: pandas; extra == "sql"
+Provides-Extra: all
+Requires-Dist: garf-executors[bq,sql]; extra == "all"
+
+# `garf-executors` - One stop-shop for interacting with Reporting APIs.
+
+`garf-executors` is responsible for orchestrating process of fetching from API and storing data in a storage.
+
+Currently the following executors are supports:
+
+* `ApiExecutor` - fetching data from reporting API and saves it to a requested destination.
+* `BigQueryExecutor` - executes SQL code in BigQuery.
+* `SqlExecutor` - executes SQL code in a SqlAlchemy supported DB.
+
+## Installation
+
+`pip install garf-executors`
+
+## Usage
+
+After `garf-executors` is installed you can use `garf` utility to perform fetching.
+
+```
+garf <QUERIES> --source <API_SOURCE> \
+  --output <OUTPUT_TYPE> \
+  --source.params1=<VALUE>
+```
+
+where
+
+* `<QUERIES>`- local or remote path(s) to files with queries.
+* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
+* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+
+If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
+> Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.

garf_executors-0.0.3/README.md

@@ -0,0 +1,32 @@
+# `garf-executors` - One stop-shop for interacting with Reporting APIs.
+
+`garf-executors` is responsible for orchestrating process of fetching from API and storing data in a storage.
+
+Currently the following executors are supports:
+
+* `ApiExecutor` - fetching data from reporting API and saves it to a requested destination.
+* `BigQueryExecutor` - executes SQL code in BigQuery.
+* `SqlExecutor` - executes SQL code in a SqlAlchemy supported DB.
+
+## Installation
+
+`pip install garf-executors`
+
+## Usage
+
+After `garf-executors` is installed you can use `garf` utility to perform fetching.
+
+```
+garf <QUERIES> --source <API_SOURCE> \
+  --output <OUTPUT_TYPE> \
+  --source.params1=<VALUE>
+```
+
+where
+
+* `<QUERIES>`- local or remote path(s) to files with queries.
+* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
+* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+
+If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
+> Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.

{garf_executors-0.0.1 → garf_executors-0.0.3}/garf_executors/__init__.py

@@ -20,7 +20,11 @@ import like this `garf_executors.ApiQueryExecutor`
 from __future__ import annotations
 
 from garf_executors.api_executor import ApiQueryExecutor
+from garf_executors.fetchers import FETCHERS
 
 __all__ = [
+  'FETCHERS',
   'ApiQueryExecutor',
 ]
+
+__version__ = '0.0.3'

garf_executors-0.0.3/garf_executors/entrypoints/cli.py

@@ -0,0 +1,127 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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 defining `garf` CLI utility.
+
+`garf` allows to execute queries and store results in local/remote
+storage.
+"""
+
+from __future__ import annotations
+
+import argparse
+import functools
+import sys
+from concurrent import futures
+
+import garf_executors
+from garf_executors import exceptions
+from garf_executors.entrypoints import utils
+from garf_io import reader, writer
+
+
+def main():
+  parser = argparse.ArgumentParser()
+  parser.add_argument('query', nargs='*')
+  parser.add_argument('-c', '--config', dest='garf_config', default=None)
+  parser.add_argument('--source', dest='source', default=None)
+  parser.add_argument('--output', dest='output', default=None)
+  parser.add_argument('--input', dest='input', default='file')
+  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
+  parser.add_argument('--logger', dest='logger', default='local')
+  parser.add_argument(
+    '--parallel-queries', dest='parallel_queries', action='store_true'
+  )
+  parser.add_argument(
+    '--no-parallel-queries', dest='parallel_queries', action='store_false'
+  )
+  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
+  parser.add_argument('-v', '--version', dest='version', action='store_true')
+  parser.add_argument(
+    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
+  )
+  parser.set_defaults(parallel_queries=True)
+  parser.set_defaults(dry_run=False)
+  args, kwargs = parser.parse_known_args()
+
+  if args.version:
+    print(garf_executors.__version__)
+    sys.exit()
+  if not (source := args.source):
+    raise exceptions.GarfExecutorError(
+      f'Select one of available sources: {list(garf_executors.FETCHERS.keys())}'
+    )
+  if not (concrete_api_fetcher := garf_executors.FETCHERS.get(source)):
+    raise exceptions.GarfExecutorError(f'Source {source} is not available.')
+
+  logger = utils.init_logging(
+    loglevel=args.loglevel.upper(), logger_type=args.logger
+  )
+  if not args.query:
+    logger.error('Please provide one or more queries to run')
+    raise exceptions.GarfExecutorError(
+      'Please provide one or more queries to run'
+    )
+
+  config = utils.ConfigBuilder('garf').build(vars(args), kwargs)
+  logger.debug('config: %s', config)
+
+  if config.params:
+    config = utils.initialize_runtime_parameters(config)
+  logger.debug('initialized config: %s', config)
+
+  extra_parameters = utils.ParamsParser(['source']).parse(kwargs)
+  query_executor = garf_executors.api_executor.ApiQueryExecutor(
+    concrete_api_fetcher()
+  )
+  reader_client = reader.create_reader(args.input)
+
+  writer_client = writer.create_writer(config.output, **config.writer_params)
+  if config.output == 'bq':
+    _ = writer_client.create_or_get_dataset()
+  if config.output == 'sheet':
+    writer_client.init_client()
+
+  if args.parallel_queries:
+    logger.info('Running queries in parallel')
+    with futures.ThreadPoolExecutor(args.parallel_threshold) as executor:
+      future_to_query = {
+        executor.submit(
+          query_executor.execute,
+          reader_client.read(query),
+          query,
+          writer_client,
+          config.params,
+          **extra_parameters.get('source', {}),
+        ): query
+        for query in args.query
+      }
+      for future in futures.as_completed(future_to_query):
+        query = future_to_query[future]
+        utils.garf_runner(query, future.result, logger)
+  else:
+    logger.info('Running queries sequentially')
+    for query in args.query:
+      callback = functools.partial(
+        query_executor.execute,
+        reader_client.read(query),
+        query,
+        writer_client,
+        config.params,
+        **extra_parameters.get('source', {}),
+      )
+      utils.garf_runner(query, callback, logger)
+
+
+if __name__ == '__main__':
+  main()

{garf_executors-0.0.1 → garf_executors-0.0.3}/garf_executors/entrypoints/utils.py

@@ -299,14 +299,16 @@ class ParamsParser:
     if not identifier or identifier not in key:
       return None
     provided_identifier, key = key.split('.')
-    if provided_identifier.replace('--', '') not in self.identifiers:
+    provided_identifier = provided_identifier.replace('--', '')
+    if provided_identifier not in self.identifiers:
       raise GarfParamsException(
         f'CLI argument {provided_identifier} is not supported'
         f", supported arguments {', '.join(self.identifiers)}"
       )
+    if provided_identifier != identifier:
+      return None
     key = key.replace('-', '_')
     if len(param) == 2:
-      # TODO: b/337860595 - Ensure that writer params are converted to int
       return {key: param[1]}
     raise GarfParamsException(
       f'{identifier} {key} is invalid,'

garf_executors-0.0.3/garf_executors/exceptions.py

@@ -0,0 +1,17 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+
+class GarfExecutorError(Exception):
+  """Base class for garf executor exceptions."""

garf_executors-0.0.3/garf_executors/fetchers.py

@@ -0,0 +1,37 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+import inspect
+from importlib.metadata import entry_points
+
+from garf_core import report_fetcher
+
+
+def get_report_fetchers() -> dict[str, report_fetcher.ApiReportFetcher]:
+  fetchers = entry_points(group='garf')
+  found_fetchers = {}
+  for fetcher in fetchers:
+    try:
+      fetcher_module = fetcher.load()
+      for name, obj in inspect.getmembers(fetcher_module):
+        if inspect.isclass(obj) and issubclass(
+          obj, report_fetcher.ApiReportFetcher
+        ):
+          found_fetchers[fetcher.name] = getattr(fetcher_module, name)
+    except ModuleNotFoundError:
+      continue
+  return found_fetchers
+
+
+FETCHERS = get_report_fetchers()

garf_executors-0.0.3/garf_executors.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.2
+Name: garf-executors
+Version: 0.0.3
+Summary: Executes queries against API and writes data to local/remote storage.
+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: garf-core
+Requires-Dist: garf-io
+Provides-Extra: bq
+Requires-Dist: garf-io[bq]; extra == "bq"
+Requires-Dist: pandas; extra == "bq"
+Provides-Extra: sql
+Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
+Requires-Dist: pandas; extra == "sql"
+Provides-Extra: all
+Requires-Dist: garf-executors[bq,sql]; extra == "all"
+
+# `garf-executors` - One stop-shop for interacting with Reporting APIs.
+
+`garf-executors` is responsible for orchestrating process of fetching from API and storing data in a storage.
+
+Currently the following executors are supports:
+
+* `ApiExecutor` - fetching data from reporting API and saves it to a requested destination.
+* `BigQueryExecutor` - executes SQL code in BigQuery.
+* `SqlExecutor` - executes SQL code in a SqlAlchemy supported DB.
+
+## Installation
+
+`pip install garf-executors`
+
+## Usage
+
+After `garf-executors` is installed you can use `garf` utility to perform fetching.
+
+```
+garf <QUERIES> --source <API_SOURCE> \
+  --output <OUTPUT_TYPE> \
+  --source.params1=<VALUE>
+```
+
+where
+
+* `<QUERIES>`- local or remote path(s) to files with queries.
+* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
+* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+
+If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
+> Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.

{garf_executors-0.0.1 → garf_executors-0.0.3}/garf_executors.egg-info/SOURCES.txt

@@ -3,6 +3,8 @@ pyproject.toml
 garf_executors/__init__.py
 garf_executors/api_executor.py
 garf_executors/bq_executor.py
+garf_executors/exceptions.py
+garf_executors/fetchers.py
 garf_executors/sql_executor.py
 garf_executors.egg-info/PKG-INFO
 garf_executors.egg-info/SOURCES.txt
@@ -11,9 +13,5 @@ garf_executors.egg-info/entry_points.txt
 garf_executors.egg-info/requires.txt
 garf_executors.egg-info/top_level.txt
 garf_executors/entrypoints/__init__.py
-garf_executors/entrypoints/utils.py
-garf_executors/entrypoints/cli/__init__.py
-garf_executors/entrypoints/cli/api.py
-garf_executors/entrypoints/cli/bq.py
-garf_executors/entrypoints/cli/gaarf.py
-garf_executors/entrypoints/cli/sql.py
+garf_executors/entrypoints/cli.py
+garf_executors/entrypoints/utils.py

garf_executors-0.0.3/garf_executors.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+garf = garf_executors.entrypoints.cli:main

{garf_executors-0.0.1 → garf_executors-0.0.3}/pyproject.toml

@@ -4,7 +4,6 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "garf-executors"
-version = "0.0.1"
 dependencies = [
   "garf-core",
   "garf-io",
@@ -28,6 +27,10 @@ classifiers = [
     "Operating System :: OS Independent",
     "License :: OSI Approved :: Apache Software License",
 ]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = {attr = "garf_executors.__version__"}
 
 [project.optional-dependencies]
 bq=[
@@ -42,5 +45,4 @@ all = [
   "garf-executors[bq,sql]"
 ]
 [project.scripts]
-garf-sql-executor="garf_executors.entrypoints.cli.sql:main"
-garf-bq-executor="garf_executors.entrypoints.cli.bq:main"
+garf="garf_executors.entrypoints.cli:main"

garf_executors-0.0.1/PKG-INFO

@@ -1,30 +0,0 @@
-Metadata-Version: 2.1
-Name: garf-executors
-Version: 0.0.1
-Summary: Executes queries against API and writes data to local/remote storage.
-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: garf-core
-Requires-Dist: garf-io
-Provides-Extra: bq
-Requires-Dist: garf-io[bq]; extra == "bq"
-Requires-Dist: pandas; extra == "bq"
-Provides-Extra: sql
-Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
-Requires-Dist: pandas; extra == "sql"
-Provides-Extra: all
-Requires-Dist: garf-executors[bq,sql]; extra == "all"
-
-# Gaarf Executors

garf_executors-0.0.1/README.md

@@ -1 +0,0 @@
-# Gaarf Executors

garf_executors-0.0.1/garf_executors/entrypoints/cli/api.py

@@ -1,213 +0,0 @@
-# Copyright 2022 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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 defing `garf` CLI utility.
-
-`garf` allows to execute GAQL queries and store results in local/remote
-storage.
-"""
-
-from __future__ import annotations
-
-import argparse
-import functools
-import sys
-from collections.abc import MutableSequence
-from concurrent import futures
-from pathlib import Path
-
-import smart_open
-import yaml
-from garf import api_clients, exceptions, query_executor
-from garf.cli import utils
-from garf.io import reader, writer
-
-
-def main():
-  parser = argparse.ArgumentParser()
-  parser.add_argument('query', nargs='*')
-  parser.add_argument('-c', '--config', dest='garf_config', default=None)
-  parser.add_argument('--account', dest='account', default=None)
-  parser.add_argument('--output', dest='output', default=None)
-  parser.add_argument('--input', dest='input', default='file')
-  parser.add_argument(
-    '--ads-config', dest='config', default=str(Path.home() / 'google-ads.yaml')
-  )
-  parser.add_argument('--api-version', dest='api_version', default=None)
-  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
-  parser.add_argument('--logger', dest='logger', default='local')
-  parser.add_argument(
-    '--customer-ids-query', dest='customer_ids_query', default=None
-  )
-  parser.add_argument(
-    '--customer-ids-query-file', dest='customer_ids_query_file', default=None
-  )
-  parser.add_argument('--save-config', dest='save_config', action='store_true')
-  parser.add_argument(
-    '--no-save-config', dest='save_config', action='store_false'
-  )
-  parser.add_argument(
-    '--config-destination', dest='save_config_dest', default='config.yaml'
-  )
-  parser.add_argument(
-    '--parallel-queries', dest='parallel_queries', action='store_true'
-  )
-  parser.add_argument(
-    '--no-parallel-queries', dest='parallel_queries', action='store_false'
-  )
-  parser.add_argument(
-    '--optimize-performance', dest='optimize_performance', default='NONE'
-  )
-  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
-  parser.add_argument(
-    '--disable-account-expansion',
-    dest='disable_account_expansion',
-    action='store_true',
-  )
-  parser.add_argument('-v', '--version', dest='version', action='store_true')
-  parser.add_argument(
-    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
-  )
-  parser.set_defaults(save_config=False)
-  parser.set_defaults(parallel_queries=True)
-  parser.set_defaults(dry_run=False)
-  parser.set_defaults(disable_account_expansion=False)
-  args = parser.parse_known_args()
-  main_args = args[0]
-
-  if main_args.version:
-    import pkg_resources
-
-    version = pkg_resources.require('google-ads-api-report-fetcher')[0].version
-    print(f'garf version {version}')
-    sys.exit()
-
-  logger = utils.init_logging(
-    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
-  )
-  if not main_args.query:
-    logger.error('Please provide one or more queries to run')
-    raise exceptions.GarfMissingQueryException(
-      'Please provide one or more queries to run'
-    )
-
-  with smart_open.open(main_args.config, 'r', encoding='utf-8') as f:
-    google_ads_config_dict = yaml.safe_load(f)
-
-  config = utils.ConfigBuilder('garf').build(vars(main_args), args[1])
-  if not config.account:
-    if mcc := google_ads_config_dict.get('login_customer_id'):
-      config.account = str(mcc)
-    else:
-      raise exceptions.GarfMissingAccountException(
-        'No account found, please specify via --account CLI flag'
-        'or add as login_customer_id in google-ads.yaml'
-      )
-  logger.debug('config: %s', config)
-
-  if main_args.save_config and not main_args.garf_config:
-    utils.ConfigSaver(main_args.save_config_dest).save(config)
-  if main_args.dry_run:
-    sys.exit()
-
-  if config.params:
-    config = utils.initialize_runtime_parameters(config)
-  logger.debug('initialized config: %s', config)
-
-  ads_client = api_clients.GoogleAdsApiClient(
-    config_dict=google_ads_config_dict,
-    version=config.api_version,
-    use_proto_plus=main_args.optimize_performance
-    not in ('PROTOBUF', 'BATCH_PROTOBUF'),
-  )
-  ads_query_executor = query_executor.AdsQueryExecutor(ads_client)
-  reader_factory = reader.ReaderFactory()
-  reader_client = reader_factory.create_reader(main_args.input)
-
-  if config.customer_ids_query:
-    customer_ids_query = config.customer_ids_query
-  elif config.customer_ids_query_file:
-    file_reader = reader_factory.create_reader('file')
-    customer_ids_query = file_reader.read(config.customer_ids_query_file)
-  else:
-    customer_ids_query = None
-
-  if main_args.disable_account_expansion:
-    logger.info(
-      'Skipping account expansion because of ' 'disable_account_expansion flag'
-    )
-    customer_ids = (
-      config.account
-      if isinstance(config.account, MutableSequence)
-      else [config.account]
-    )
-  else:
-    customer_ids = ads_query_executor.expand_mcc(
-      config.account, customer_ids_query
-    )
-  if not customer_ids:
-    logger.warning(
-      'Not a single under MCC %s is found that satisfies '
-      'the following customer_id query: "%s"',
-      config.account,
-      customer_ids_query,
-    )
-    sys.exit()
-  writer_client = writer.WriterFactory().create_writer(
-    config.output, **config.writer_params
-  )
-  if config.output == 'bq':
-    _ = writer_client.create_or_get_dataset()
-  if config.output == 'sheet':
-    writer_client.init_client()
-
-  logger.info(
-    'Total number of customer_ids is %d, accounts=[%s]',
-    len(customer_ids),
-    ','.join(map(str, customer_ids)),
-  )
-
-  if main_args.parallel_queries:
-    logger.info('Running queries in parallel')
-    with futures.ThreadPoolExecutor(main_args.parallel_threshold) as executor:
-      future_to_query = {
-        executor.submit(
-          ads_query_executor.execute,
-          reader_client.read(query),
-          query,
-          customer_ids,
-          writer_client,
-          config.params,
-          main_args.optimize_performance,
-        ): query
-        for query in main_args.query
-      }
-      for future in futures.as_completed(future_to_query):
-        query = future_to_query[future]
-        utils.garf_runner(query, future.result, logger)
-  else:
-    logger.info('Running queries sequentially')
-    for query in main_args.query:
-      callback = functools.partial(
-        ads_query_executor.execute,
-        reader_client.read(query),
-        query,
-        customer_ids,
-        writer_client,
-        config.params,
-        main_args.optimize_performance,
-      )
-      utils.garf_runner(query, callback, logger)
-
-
-if __name__ == '__main__':
-  main()

garf_executors-0.0.1/garf_executors/entrypoints/cli/bq.py

@@ -1,112 +0,0 @@
-# Copyright 2022 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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 defing `garf-bq` CLI utility.
-
-`garf-bq` allows to execute BigQuery queries based on Garf config.
-"""
-
-from __future__ import annotations
-
-import argparse
-import functools
-import sys
-from concurrent import futures
-
-from garf_writers import reader  # type: ignore
-
-from garf_executors import bq_executor
-from garf_executors.entrypoints import utils
-
-
-def main():
-  parser = argparse.ArgumentParser()
-  parser.add_argument('query', nargs='+')
-  parser.add_argument('-c', '--config', dest='garf_config', default=None)
-  parser.add_argument('--project', dest='project')
-  parser.add_argument(
-    '--dataset-location', dest='dataset_location', default=None
-  )
-  parser.add_argument('--save-config', dest='save_config', action='store_true')
-  parser.add_argument(
-    '--no-save-config', dest='save_config', action='store_false'
-  )
-  parser.add_argument(
-    '--config-destination', dest='save_config_dest', default='config.yaml'
-  )
-  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
-  parser.add_argument('--logger', dest='logger', default='local')
-  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
-  parser.add_argument(
-    '--parallel-queries', dest='parallel_queries', action='store_true'
-  )
-  parser.add_argument(
-    '--no-parallel-queries', dest='parallel_queries', action='store_false'
-  )
-  parser.add_argument(
-    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
-  )
-  parser.set_defaults(save_config=False)
-  parser.set_defaults(dry_run=False)
-  parser.set_defaults(parallel_queries=True)
-  args = parser.parse_known_args()
-  main_args = args[0]
-
-  logger = utils.init_logging(
-    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
-  )
-  config = utils.ConfigBuilder('garf-bq').build(vars(main_args), args[1])
-  logger.debug('config: %s', config)
-  if main_args.save_config and not main_args.garf_config:
-    utils.ConfigSaver(main_args.save_config_dest).save(config)
-  if main_args.dry_run:
-    sys.exit()
-
-  config = utils.initialize_runtime_parameters(config)
-  logger.debug('initialized config: %s', config)
-
-  bigquery_executor = bq_executor.BigQueryExecutor(
-    project_id=config.project, location=config.dataset_location
-  )
-  bigquery_executor.create_datasets(config.params.get('macro'))
-
-  reader_client = reader.FileReader()
-
-  if main_args.parallel_queries:
-    logger.info('Running queries in parallel')
-    with futures.ThreadPoolExecutor(
-      max_workers=main_args.parallel_threshold
-    ) as executor:
-      future_to_query = {
-        executor.submit(
-          bigquery_executor.execute,
-          query,
-          reader_client.read(query),
-          config.params,
-        ): query
-        for query in sorted(main_args.query)
-      }
-      for future in futures.as_completed(future_to_query):
-        query = future_to_query[future]
-        utils.postprocessor_runner(query, future.result, logger)
-  else:
-    logger.info('Running queries sequentially')
-    for query in sorted(main_args.query):
-      callback = functools.partial(
-        executor.execute, query, reader_client.read(query), config.params
-      )
-      utils.postprocessor_runner(query, callback, logger)
-
-
-if __name__ == '__main__':
-  main()

garf_executors-0.0.1/garf_executors/entrypoints/cli/gaarf.py

@@ -1,213 +0,0 @@
-# Copyright 2022 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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 defing `garf` CLI utility.
-
-`garf` allows to execute GAQL queries and store results in local/remote
-storage.
-"""
-
-from __future__ import annotations
-
-import argparse
-import functools
-import sys
-from collections.abc import MutableSequence
-from concurrent import futures
-from pathlib import Path
-
-import smart_open
-import yaml
-from garf import api_clients, exceptions, query_executor
-from garf.cli import utils
-from garf.io import reader, writer
-
-
-def main():
-  parser = argparse.ArgumentParser()
-  parser.add_argument('query', nargs='*')
-  parser.add_argument('-c', '--config', dest='garf_config', default=None)
-  parser.add_argument('--account', dest='account', default=None)
-  parser.add_argument('--output', dest='output', default=None)
-  parser.add_argument('--input', dest='input', default='file')
-  parser.add_argument(
-    '--ads-config', dest='config', default=str(Path.home() / 'google-ads.yaml')
-  )
-  parser.add_argument('--api-version', dest='api_version', default=None)
-  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
-  parser.add_argument('--logger', dest='logger', default='local')
-  parser.add_argument(
-    '--customer-ids-query', dest='customer_ids_query', default=None
-  )
-  parser.add_argument(
-    '--customer-ids-query-file', dest='customer_ids_query_file', default=None
-  )
-  parser.add_argument('--save-config', dest='save_config', action='store_true')
-  parser.add_argument(
-    '--no-save-config', dest='save_config', action='store_false'
-  )
-  parser.add_argument(
-    '--config-destination', dest='save_config_dest', default='config.yaml'
-  )
-  parser.add_argument(
-    '--parallel-queries', dest='parallel_queries', action='store_true'
-  )
-  parser.add_argument(
-    '--no-parallel-queries', dest='parallel_queries', action='store_false'
-  )
-  parser.add_argument(
-    '--optimize-performance', dest='optimize_performance', default='NONE'
-  )
-  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
-  parser.add_argument(
-    '--disable-account-expansion',
-    dest='disable_account_expansion',
-    action='store_true',
-  )
-  parser.add_argument('-v', '--version', dest='version', action='store_true')
-  parser.add_argument(
-    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
-  )
-  parser.set_defaults(save_config=False)
-  parser.set_defaults(parallel_queries=True)
-  parser.set_defaults(dry_run=False)
-  parser.set_defaults(disable_account_expansion=False)
-  args = parser.parse_known_args()
-  main_args = args[0]
-
-  if main_args.version:
-    import pkg_resources
-
-    version = pkg_resources.require('google-ads-api-report-fetcher')[0].version
-    print(f'garf version {version}')
-    sys.exit()
-
-  logger = utils.init_logging(
-    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
-  )
-  if not main_args.query:
-    logger.error('Please provide one or more queries to run')
-    raise exceptions.GarfMissingQueryException(
-      'Please provide one or more queries to run'
-    )
-
-  with smart_open.open(main_args.config, 'r', encoding='utf-8') as f:
-    google_ads_config_dict = yaml.safe_load(f)
-
-  config = utils.ConfigBuilder('garf').build(vars(main_args), args[1])
-  if not config.account:
-    if mcc := google_ads_config_dict.get('login_customer_id'):
-      config.account = str(mcc)
-    else:
-      raise exceptions.GarfMissingAccountException(
-        'No account found, please specify via --account CLI flag'
-        'or add as login_customer_id in google-ads.yaml'
-      )
-  logger.debug('config: %s', config)
-
-  if main_args.save_config and not main_args.garf_config:
-    utils.ConfigSaver(main_args.save_config_dest).save(config)
-  if main_args.dry_run:
-    sys.exit()
-
-  if config.params:
-    config = utils.initialize_runtime_parameters(config)
-  logger.debug('initialized config: %s', config)
-
-  ads_client = api_clients.GoogleAdsApiClient(
-    config_dict=google_ads_config_dict,
-    version=config.api_version,
-    use_proto_plus=main_args.optimize_performance
-    not in ('PROTOBUF', 'BATCH_PROTOBUF'),
-  )
-  ads_query_executor = query_executor.AdsQueryExecutor(ads_client)
-  reader_factory = reader.ReaderFactory()
-  reader_client = reader_factory.create_reader(main_args.input)
-
-  if config.customer_ids_query:
-    customer_ids_query = config.customer_ids_query
-  elif config.customer_ids_query_file:
-    file_reader = reader_factory.create_reader('file')
-    customer_ids_query = file_reader.read(config.customer_ids_query_file)
-  else:
-    customer_ids_query = None
-
-  if main_args.disable_account_expansion:
-    logger.info(
-      'Skipping account expansion because of ' 'disable_account_expansion flag'
-    )
-    customer_ids = (
-      config.account
-      if isinstance(config.account, MutableSequence)
-      else [config.account]
-    )
-  else:
-    customer_ids = ads_query_executor.expand_mcc(
-      config.account, customer_ids_query
-    )
-  if not customer_ids:
-    logger.warning(
-      'Not a single under MCC %s is found that satisfies '
-      'the following customer_id query: "%s"',
-      config.account,
-      customer_ids_query,
-    )
-    sys.exit()
-  writer_client = writer.WriterFactory().create_writer(
-    config.output, **config.writer_params
-  )
-  if config.output == 'bq':
-    _ = writer_client.create_or_get_dataset()
-  if config.output == 'sheet':
-    writer_client.init_client()
-
-  logger.info(
-    'Total number of customer_ids is %d, accounts=[%s]',
-    len(customer_ids),
-    ','.join(map(str, customer_ids)),
-  )
-
-  if main_args.parallel_queries:
-    logger.info('Running queries in parallel')
-    with futures.ThreadPoolExecutor(main_args.parallel_threshold) as executor:
-      future_to_query = {
-        executor.submit(
-          ads_query_executor.execute,
-          reader_client.read(query),
-          query,
-          customer_ids,
-          writer_client,
-          config.params,
-          main_args.optimize_performance,
-        ): query
-        for query in main_args.query
-      }
-      for future in futures.as_completed(future_to_query):
-        query = future_to_query[future]
-        utils.garf_runner(query, future.result, logger)
-  else:
-    logger.info('Running queries sequentially')
-    for query in main_args.query:
-      callback = functools.partial(
-        ads_query_executor.execute,
-        reader_client.read(query),
-        query,
-        customer_ids,
-        writer_client,
-        config.params,
-        main_args.optimize_performance,
-      )
-      utils.garf_runner(query, callback, logger)
-
-
-if __name__ == '__main__':
-  main()

garf_executors-0.0.1/garf_executors/entrypoints/cli/sql.py

@@ -1,109 +0,0 @@
-# Copyright 2023 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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 defing `garf` CLI utility.
-
-`garf-sql` allows to execute SQL queries in various Databases via SqlAlchemy.
-"""
-
-from __future__ import annotations
-
-import argparse
-import functools
-import sys
-from concurrent import futures
-
-import sqlalchemy
-from garf_writers import reader  # type: ignore
-
-from garf_executors import sql_executor
-from garf_executors.entrypoints import utils
-
-
-def main():
-  parser = argparse.ArgumentParser()
-  parser.add_argument('query', nargs='+')
-  parser.add_argument('-c', '--config', dest='garf_config', default=None)
-  parser.add_argument('--conn', '--connection-string', dest='connection_string')
-  parser.add_argument('--save-config', dest='save_config', action='store_true')
-  parser.add_argument(
-    '--no-save-config', dest='save_config', action='store_false'
-  )
-  parser.add_argument(
-    '--config-destination', dest='save_config_dest', default='config.yaml'
-  )
-  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
-  parser.add_argument('--logger', dest='logger', default='local')
-  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
-  parser.add_argument(
-    '--parallel-queries', dest='parallel_queries', action='store_true'
-  )
-  parser.add_argument(
-    '--no-parallel-queries', dest='parallel_queries', action='store_false'
-  )
-  parser.add_argument(
-    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
-  )
-  parser.set_defaults(save_config=False)
-  parser.set_defaults(dry_run=False)
-  parser.set_defaults(parallel_queries=True)
-  args = parser.parse_known_args()
-  main_args = args[0]
-
-  logger = utils.init_logging(
-    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
-  )
-
-  config = utils.ConfigBuilder('garf-sql').build(vars(main_args), args[1])
-  logger.debug('config: %s', config)
-  if main_args.save_config and not main_args.garf_config:
-    utils.ConfigSaver(main_args.save_config_dest).save(config)
-  if main_args.dry_run:
-    sys.exit()
-
-  config = utils.initialize_runtime_parameters(config)
-  logger.debug('initialized config: %s', config)
-
-  engine = sqlalchemy.create_engine(config.connection_string)
-  sqlalchemy_query_executor = sql_executor.SqlAlchemyQueryExecutor(engine)
-
-  reader_client = reader.FileReader()
-
-  if main_args.parallel_queries:
-    logger.info('Running queries in parallel')
-    with futures.ThreadPoolExecutor(
-      max_workers=main_args.parallel_threshold
-    ) as executor:
-      future_to_query = {
-        executor.submit(
-          sqlalchemy_query_executor.execute,
-          query,
-          reader_client.read(query),
-          config.params,
-        ): query
-        for query in sorted(main_args.query)
-      }
-      for future in futures.as_completed(future_to_query):
-        query = future_to_query[future]
-        utils.postprocessor_runner(query, future.result, logger)
-  else:
-    logger.info('Running queries sequentially')
-    for query in sorted(main_args.query):
-      callback = functools.partial(
-        executor.execute, query, reader_client.read(query), config.params
-      )
-      utils.postprocessor_runner(query, callback, logger)
-
-
-if __name__ == '__main__':
-  main()

garf_executors-0.0.1/garf_executors.egg-info/PKG-INFO

@@ -1,30 +0,0 @@
-Metadata-Version: 2.1
-Name: garf-executors
-Version: 0.0.1
-Summary: Executes queries against API and writes data to local/remote storage.
-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: garf-core
-Requires-Dist: garf-io
-Provides-Extra: bq
-Requires-Dist: garf-io[bq]; extra == "bq"
-Requires-Dist: pandas; extra == "bq"
-Provides-Extra: sql
-Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
-Requires-Dist: pandas; extra == "sql"
-Provides-Extra: all
-Requires-Dist: garf-executors[bq,sql]; extra == "all"
-
-# Gaarf Executors

garf_executors-0.0.1/garf_executors.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-garf-bq-executor = garf_executors.entrypoints.cli.bq:main
-garf-sql-executor = garf_executors.entrypoints.cli.sql:main