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.0.6.tar.gz (20.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.6-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_executors-1.0.6.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.6.tar.gz
Algorithm Hash digest
SHA256 946a251cc7010ae403cf218f10f13173f0bbd094d1be4b60dd87938479ae33dd
MD5 98a7ec8ae1dffaa2dde1d275106f5f4b
BLAKE2b-256 46d176f2f24b51a055d3afdc028c98f34e1a03d603b532732307f7e933bbdcce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_executors-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 41.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2017b32e0766faa139b07ee839102fd5b617c0490db150e7f7340e46ff6d1111
MD5 e222e5ebb5c72be4147680926e2b1af9
BLAKE2b-256 525ab632e1934d374623fba2f0eca9fa701e07a00a0856d5719b69248ee835d9

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