6. Creation of Excel spreadsheets

Excel submodule containing ExcelWriter formats.

ptmd.lib.excel.formats.get_empty_cells_format(writer: ExcelWriter) Format

Get the cell formatter.

Parameters

writer – The writer to use.

Returns

The cell formatter.

ptmd.lib.excel.formats.get_extra_cells_format(writer: ExcelWriter) Format

Get the cell formatter.

Parameters

writer – The writer to use.

Returns

The cell formatter.

ptmd.lib.excel.formats.get_header_format(writer: ExcelWriter) Format

Get the sample formatter.

Parameters

writer – The writer to use.

Returns

The sample formatter.

ptmd.lib.excel.formats.set_common_formats(formatter: Format) Format

Set the common formats.

Returns

The common formats.

Excel submodule that contains the save function

ptmd.lib.excel.save.save_to_excel(dataframes: tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame], path: str) str

Save the dataframes to an Excel file.

Parameters
  • dataframes – The dataframes to save.

  • path – The path to save the file to.

Excel submodule that contains the styling functions. Consumes the format functions outputs.

ptmd.lib.excel.styles.style_general_sheet(writer: ExcelWriter) None

Style the general sheet.

Parameters

writer – The writer to use.

ptmd.lib.excel.styles.style_sample_sheet(writer: ExcelWriter) None

Style the sample sheet.

Parameters

writer – The writer to use.

ptmd.lib.excel.styles.style_sheets(writer: ExcelWriter) None

Style the sheets.

Parameters

writer – The writer to use.