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.
  • source- type of API to use. Based on that the appropriate report fetcher will be initialized. Explore supported APIs here
  • output - 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.

Documentation

Explore full documentation working with garf-executors

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.5.0.tar.gz (33.3 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.5.0-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_executors-1.5.0.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.5.0.tar.gz
Algorithm Hash digest
SHA256 5671874e31c7642e12c004a51434bd7c3c2e0cce630000d6fb347dac2deed454
MD5 19fefc49fab7bd7e3283efffbb4a9854
BLAKE2b-256 75dd32896b415a88f896f15ed3bd048c337af12b2307113b3acbdbbc38e7d120

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_executors-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 62.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e625fc8cbb629acd0e80f4260f34678df635eefb3753eb4512023ec3237486e
MD5 2b33a79f700b8ce07fb299af04e62bd5
BLAKE2b-256 d5b38d952c8fb5bbff68e82297c38fe992d542765084dcf501931dbf9e544a93

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