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.3.0.tar.gz (25.1 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.3.0-py3-none-any.whl (49.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_executors-1.3.0.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","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.3.0.tar.gz
Algorithm Hash digest
SHA256 27ca2367312c9d6f64cbf6e43f50cee464b6d8e264ec5e638f3215dafc1951ef
MD5 feb46019f993aed3c71bad63e187eb2a
BLAKE2b-256 5cd8771af9d5021b0235d5e09d44f6effbc0032603eb684f32f01d2eb6bb46bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_executors-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 49.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9995fc44e13b3152da4525a337ed0051ccfd9ea9988087ffd19298be44695257
MD5 366db9f04a11530a5359157e9c47ab90
BLAKE2b-256 69f3cc9a8f217c5b7aa79df6100d49bf6a91cb096ffe5331563d82131c7eaaa2

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