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.4.tar.gz (25.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.3.4-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_executors-1.3.4.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","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.4.tar.gz
Algorithm Hash digest
SHA256 d9551e3a5ff59bd4bc8db801778c15525b94dbdbc073c89e3845c870da3384e4
MD5 477f881a9eb015fa4163bc9ad6d94e70
BLAKE2b-256 795eb2b446846eecd5ae34a5e11e3da418f823d6ae718f49d4321132103f4062

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_executors-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 50.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 24d5c7dc3e2c9b53229ecec411db8d60d4e5baa68bfe45890046eebb444f54d1
MD5 b77b09dcb1fe77575c367b803570c8e4
BLAKE2b-256 f6fdbe7a77bac8dda06ef4d9a1100ea7bc6411d9d94d0e48c1f771c6310234f2

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