piper.io.read_excel_sheets

piper.io.read_excel_sheets(filename=None, sheets=None, include_sheet=False, column='sheet_name', info=False, return_type='list_frames', **kwargs)

For given Excel file name, return all or selected (list of) sheets as a consolidated pandas DataFrame

Examples

test1, test2 = read_excel_sheets(xl_file, return_type=’list_frames’)

Parameters

• - Excel Workbook (name) to be interrogated (filename) –

• None (default) –

• - list of selected sheets within Excel to be considered (sheets) – default None (include all sheets)

• - include in returned dataframe a column containing sheet (include_sheet) – name. Default False

• - sheet column name (column) –

• 'sheet_name' (default) –

• - keyword arguments to be passed to ExcelFile.parse() method (**kwargs) –

• - print sheet names(s) read including rows (info) –

• retrieved (columns) –

• - (str) options are (return_type) –

  ‘list_frames’ - (default) return a list of dataframes

  ’list’ - return list of sheet names

  ’dict_frames’ - return a dictionary containing:

  sheet_name: dataframe

  ’combine’ - return consolidated sheets in ONE dataframe

  ’metadata’ - return dataframe containing filename, sheet, rows, cols

piper.io.read_csvs piper.io.read_excels