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,format=json|jsonl
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.6.tar.gz (12.0 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.6-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for garf_io-0.0.6.tar.gz
Algorithm Hash digest
SHA256 2e9a06dca9f49d584910848795178527d952b5c8af6083531ec1f401ffd6df29
MD5 85f236fd454a3dba1124c6501187f8a3
BLAKE2b-256 80bada4110ba51503c417894f31d2b43ac438fc7e44769eb9ad71372f6ce02cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_io-0.0.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a4cef94cfdfe84ade3b8ff007007b3ef24ff7c53c6ec5f62d0a315bde5e73ceb
MD5 a7f6f772dd6ee6a55d6fd8296797805e
BLAKE2b-256 96e694081cf62f707e4ca88b89b2d2aa61e3568278abf31437637cb90eeb25f2

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