save_spreadsheet
- pyhelpers.store.save_spreadsheet(spreadsheet_data, path_to_spreadsheet, index=False, engine=None, delimiter=',', verbose=False, **kwargs)
Save data to a CSV or an Microsoft Excel file.
The file extension can be “.txt”, “.csv”, “.xlsx” or “.xls”; engines can include: xlsxwriter (for .xlsx) and openpyxl (for .xlsx/.xlsm).
- Parameters
spreadsheet_data (pandas.DataFrame) – data that could be saved as a spreadsheet (e.g. with a file extension “.xlsx” or “.csv”)
path_to_spreadsheet (str or os.PathLike[str] or None) – path where a spreadsheet is saved
index (bool) – whether to include the index as a column, defaults to
False
engine (str or None) – options include
'openpyxl'
for latest Excel file formats,'xlrd'
for .xls'odf'
for OpenDocument file formats (.odf, .ods, .odt), and'pyxlsb'
for Binary Excel files; defaults toNone
delimiter (str) – separator for saving a “.xlsx” (or “.xls”) file as a “.csv” file, defaults to
','
verbose (bool or int) – whether to print relevant information in console, defaults to
False
kwargs – [optional] parameters of pandas.DataFrame.to_excel or pandas.DataFrame.to_csv
Examples:
>>> from pyhelpers.store import save_spreadsheet >>> from pyhelpers.dirs import cd >>> from pyhelpers._cache import example_dataframe >>> # Get an example dataframe >>> spreadsheet_dat = example_dataframe() >>> spreadsheet_dat Longitude Latitude City London -0.127647 51.507322 Birmingham -1.902691 52.479699 Manchester -2.245115 53.479489 Leeds -1.543794 53.797418 >>> spreadsheet_pathname = cd("tests\data", "dat.csv") >>> save_spreadsheet(spreadsheet_dat, spreadsheet_pathname, index=True, verbose=True) Saving "dat.csv" to "tests\data\" ... Done. >>> spreadsheet_pathname = cd("tests\data", "dat.xlsx") >>> save_spreadsheet(spreadsheet_dat, spreadsheet_pathname, index=True, verbose=True) Saving "dat.xlsx" to "tests\data\" ... Done.