Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.78 KB

index.rst

File metadata and controls

50 lines (35 loc) · 1.78 KB

xlcompose

A declarative API for composing spreadsheets from python that is built on xlsxwriter and pandas and inspired by bokeh.

Why use xlcompose?

xlcompose provides a sweet spot between pandas to_excel and the xlsxwriter API. If you've ever needed to export multiple dataframes to a spreadsheet or apply custom formatting, then you know pandas isn't up to the task.

On the other hand, xlsxwriter provides a tremendous amount of customization, but it's imperative style can often lead to very verbose code.

With xlcompose, several components are provided through a set of classes to allow for highly composable spreadsheets.

There are several classes that allow for the export of data from Python:

  • ~xlcompose.core.Series - A class with formatting options for pandas Series
  • ~xlcompose.core.DataFrame - A class with formatting options for pandas DataFrames
  • ~xlcompose.core.Image - A class for exporting images
  • ~xlcompose.core.Title - A convenience class around a Series for titling

Layout components include:

  • ~xlcompose.core.Row - A class for laying out other components horizontally
  • ~xlcompose.core.Column - A class for laying our other components vertically
  • ~xlcompose.core.CSpacer - A class for adding spacing between components in a Column
  • ~xlcompose.core.RSpacer - A class for adding spacing between components in a Row
  • ~xlcompose.core.Sheet - A class for specifying sheet options
  • ~xlcompose.core.Tabs - A class for laying out other components across sheets

examples templating modules

Indices and tables

  • genindex
  • modindex
  • search