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.4.3.tar.gz (32.7 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.4.3-py3-none-any.whl (61.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_executors-1.4.3.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.4.3.tar.gz
Algorithm Hash digest
SHA256 204de39a91d72cd7a8e933b41515da39b348cc1ec1a4ce9dd0b31293b02c093b
MD5 22b3fe35364eebf706ea811dc77b4fe8
BLAKE2b-256 5ca77500d0252baff0677c5dcf45447a1fbf1886a160edb69e6f152891e64745

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_executors-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 61.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 95fc265a072a488ae0162025859c429c2ffdade06759d7cfa5a203e98880461e
MD5 e90d735b0d3ac5b40823be4e7e728dba
BLAKE2b-256 c251c35a6961253abcf285a10d727d410e867d6441dce19feabe649c2b1927bc

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