Skip to main content

Executes queries against API and writes data to local/remote storage.

Project description

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

garf_executors-1.0.1.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

garf_executors-1.0.1-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file garf_executors-1.0.1.tar.gz.

File metadata

  • Download URL: garf_executors-1.0.1.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for garf_executors-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b4fea0a2fd9a1339581376e500598f436668caaea57c45985d2963aab8b67766
MD5 e1791a1da14f67e60bc08b4c9cd262ce
BLAKE2b-256 e5f872a60282b6749ca58ed111e6141aaf57e7e232ee135baa7c4b8cd4e3eddf

See more details on using hashes here.

File details

Details for the file garf_executors-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: garf_executors-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for garf_executors-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 044685367fd95f488e2a46158be131b9b7f2110c4ddf5be0e3e64d813e2eaa2a
MD5 25d89edb00a38b55d05fbcce6e63721f
BLAKE2b-256 1c359e904ba9f7047fd7016e89d1f6e2f66f3f760831cb04a419a0148fe0e55c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page