garf-io 0.0.12

Handles reading queries and writing GarfReport from garf-core package

garf-io - Writing GarfReport to anywhere

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|jsonl
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

Each of writer also support two options for dealing with arrays:

• WRITER.array-handling - arrays handling method: "strings" (default) - store arrays as strings (items combined via a separator, e.g. "item1|item2"), "arrays" - store arrays as arrays.
• WRITER.array-separator - a separator symbol for joining arrays as strings, by default '|'.

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')