Skip to main content

Handles reading queries and writing GarfReport from garf-core package

Project description

garf-io - Writing GarfReport to anywhere

PyPI Downloads PyPI

garf-io handles reading queries and writing GarfReport to various local/remote storages.

Currently it supports writing data to the following destination:

identifier Writer Options
console ConsoleWriter page-size=10,format=table|json
csv CsvWriter destination-folder
json JsonWriter destination-folder
bq BigQueryWriter project, dataset, location, write-disposition
sqldb SqlAlchemyWriter connection-string, if-exists=fail|replace|append
sheets SheetsWriter share-with, credentials-file, spreadsheet-url, is_append=True|False

Installation

pip install garf-io

By default garf-io has only support for console, csv and json writers.
To install all writers use the following command pip install garf-io[all].
To install specific writers use:

  • pip install garf-io[bq] for BigQuery support
  • pip install garf-io[sheets] for Google spreadsheets support
  • pip install garf-io[sqlalchemy] for SqlAlchemy support

Usage

import garf_core import report
from garf_io import writer

# Create example report
sample_report = report.GarfReport(results=[[1]], column_names=['one'])

# Initialize CSV writer
concrete_writer = writer.create_writer('csv', destination_folder='/tmp/')

# Write data to /tmp/sample.csv
concrete_writer.write(sample_report, 'sample')

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_io-0.0.4.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

garf_io-0.0.4-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file garf_io-0.0.4.tar.gz.

File metadata

  • Download URL: garf_io-0.0.4.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.29

File hashes

Hashes for garf_io-0.0.4.tar.gz
Algorithm Hash digest
SHA256 37f99165cfccc666479ccd18cfb92b57550826760dee76387ae437b8a4440d46
MD5 1fd5086293889d912f1fd7e5d063b365
BLAKE2b-256 b147468cb73f3db7cf23a81bbfbdab6da90ef66d9bcf6145032997b5c8931002

See more details on using hashes here.

File details

Details for the file garf_io-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: garf_io-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.29

File hashes

Hashes for garf_io-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1f402af053019e03c30ccda876b05a6f52b805f4cc7c20a505f816eb30415e13
MD5 5ce404926185a1a85ab6fc9f0d41ca13
BLAKE2b-256 7a6bddda9396c399cc618340efccb3c5fb28ffa8a392f6a5bae2d49db9ce45a0

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