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.5.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.5-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garf_io-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 8dffd1e3e3b3f91035f866abe5bd1fb395d7f37ec4646cbdda51345ea92be06b
MD5 b2b5209ed3f802080c3ae91a1c088764
BLAKE2b-256 8ae6b06eecafe10a704efdffb1f34d4e827251e9efbaa02ca826a2415680374b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garf_io-0.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b2fac22bd486a245abc328e0b0dd4fada77c2d13605c72e45439de96b18eb972
MD5 8bcea206c82740e136d6ce7375a9cf2c
BLAKE2b-256 1a439b29febadcc44cfe633a14c7d18c995d17bfe249c1b42cec0ff2620bc9dc

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