# fastpyxl

> A high-performance Python library to read/write Excel 2010 xlsx/xlsm files

## Docs

### API Reference

#### Classes
> Main classes provided by the package

- [Workbook](https://promptlytechnologies.com/fastpyxl/reference/Workbook.html): Workbook is the container for all other parts of the document
- [cell.Cell](https://promptlytechnologies.com/fastpyxl/reference/cell.Cell.html)
- [cell.MergedCell](https://promptlytechnologies.com/fastpyxl/reference/cell.MergedCell.html)
- [cell.ReadOnlyCell](https://promptlytechnologies.com/fastpyxl/reference/cell.ReadOnlyCell.html)
- [chart.AreaChart](https://promptlytechnologies.com/fastpyxl/reference/chart.AreaChart.html)
- [chart.AreaChart3D](https://promptlytechnologies.com/fastpyxl/reference/chart.AreaChart3D.html)
- [chart.BarChart](https://promptlytechnologies.com/fastpyxl/reference/chart.BarChart.html)
- [chart.BarChart3D](https://promptlytechnologies.com/fastpyxl/reference/chart.BarChart3D.html)
- [chart.BubbleChart](https://promptlytechnologies.com/fastpyxl/reference/chart.BubbleChart.html)
- [chart.DoughnutChart](https://promptlytechnologies.com/fastpyxl/reference/chart.DoughnutChart.html)
- [chart.LineChart](https://promptlytechnologies.com/fastpyxl/reference/chart.LineChart.html)
- [chart.LineChart3D](https://promptlytechnologies.com/fastpyxl/reference/chart.LineChart3D.html)
- [chart.PieChart](https://promptlytechnologies.com/fastpyxl/reference/chart.PieChart.html)
- [chart.PieChart3D](https://promptlytechnologies.com/fastpyxl/reference/chart.PieChart3D.html)
- [chart.ProjectedPieChart](https://promptlytechnologies.com/fastpyxl/reference/chart.ProjectedPieChart.html)
- [chart.RadarChart](https://promptlytechnologies.com/fastpyxl/reference/chart.RadarChart.html)
- [chart.Reference](https://promptlytechnologies.com/fastpyxl/reference/chart.Reference.html)
- [chart.ScatterChart](https://promptlytechnologies.com/fastpyxl/reference/chart.ScatterChart.html)
- [chart.StockChart](https://promptlytechnologies.com/fastpyxl/reference/chart.StockChart.html)
- [chart.SurfaceChart](https://promptlytechnologies.com/fastpyxl/reference/chart.SurfaceChart.html)
- [chart.SurfaceChart3D](https://promptlytechnologies.com/fastpyxl/reference/chart.SurfaceChart3D.html)
- [chartsheet.Chartsheet](https://promptlytechnologies.com/fastpyxl/reference/chartsheet.Chartsheet.html)
- [comments.Comment](https://promptlytechnologies.com/fastpyxl/reference/comments.Comment.html)
- [drawing.Drawing](https://promptlytechnologies.com/fastpyxl/reference/drawing.Drawing.html)
- [formatting.Rule](https://promptlytechnologies.com/fastpyxl/reference/formatting.Rule.html)
- [formula.Tokenizer](https://promptlytechnologies.com/fastpyxl/reference/formula.Tokenizer.html)
- [styles.Alignment](https://promptlytechnologies.com/fastpyxl/reference/styles.Alignment.html)
- [styles.Border](https://promptlytechnologies.com/fastpyxl/reference/styles.Border.html)
- [styles.Color](https://promptlytechnologies.com/fastpyxl/reference/styles.Color.html)
- [styles.Fill](https://promptlytechnologies.com/fastpyxl/reference/styles.Fill.html)
- [styles.Font](https://promptlytechnologies.com/fastpyxl/reference/styles.Font.html)
- [styles.GradientFill](https://promptlytechnologies.com/fastpyxl/reference/styles.GradientFill.html)
- [styles.NamedStyle](https://promptlytechnologies.com/fastpyxl/reference/styles.NamedStyle.html)
- [styles.NumberFormatDescriptor](https://promptlytechnologies.com/fastpyxl/reference/styles.NumberFormatDescriptor.html)
- [styles.PatternFill](https://promptlytechnologies.com/fastpyxl/reference/styles.PatternFill.html)
- [styles.Protection](https://promptlytechnologies.com/fastpyxl/reference/styles.Protection.html)
- [styles.Side](https://promptlytechnologies.com/fastpyxl/reference/styles.Side.html)
- [typed_serialisable.ElementList](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.ElementList.html)
- [typed_serialisable.Extension](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.Extension.html)
- [typed_serialisable.ExtensionList](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.ExtensionList.html)
- [typed_serialisable.MetaSerialisable](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.MetaSerialisable.html)
- [typed_serialisable.NestedValInt](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.NestedValInt.html)
- [typed_serialisable.Serialisable](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.Serialisable.html)

#### Dataclasses
> Dataclass definitions

- [typed_serialisable.FieldInfo](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.FieldInfo.html)

#### Workbook Methods
> Methods for the Workbook class

- [Workbook.create_sheet](https://promptlytechnologies.com/fastpyxl/reference/Workbook.create_sheet.html)
- [Workbook.move_sheet](https://promptlytechnologies.com/fastpyxl/reference/Workbook.move_sheet.html)
- [Workbook.remove](https://promptlytechnologies.com/fastpyxl/reference/Workbook.remove.html)
- [Workbook.remove_sheet](https://promptlytechnologies.com/fastpyxl/reference/Workbook.remove_sheet.html)
- [Workbook.create_chartsheet](https://promptlytechnologies.com/fastpyxl/reference/Workbook.create_chartsheet.html)
- [Workbook.get_sheet_by_name](https://promptlytechnologies.com/fastpyxl/reference/Workbook.get_sheet_by_name.html)
- [Workbook.__contains__](https://promptlytechnologies.com/fastpyxl/reference/Workbook.__contains__.html)
- [Workbook.index](https://promptlytechnologies.com/fastpyxl/reference/Workbook.index.html)
- [Workbook.get_index](https://promptlytechnologies.com/fastpyxl/reference/Workbook.get_index.html)
- [Workbook.__getitem__](https://promptlytechnologies.com/fastpyxl/reference/Workbook.__getitem__.html)
- [Workbook.__delitem__](https://promptlytechnologies.com/fastpyxl/reference/Workbook.__delitem__.html)
- [Workbook.__iter__](https://promptlytechnologies.com/fastpyxl/reference/Workbook.__iter__.html)
- [Workbook.get_sheet_names](https://promptlytechnologies.com/fastpyxl/reference/Workbook.get_sheet_names.html)
- [Workbook.create_named_range](https://promptlytechnologies.com/fastpyxl/reference/Workbook.create_named_range.html)
- [Workbook.add_named_style](https://promptlytechnologies.com/fastpyxl/reference/Workbook.add_named_style.html)
- [Workbook.save](https://promptlytechnologies.com/fastpyxl/reference/Workbook.save.html)
- [Workbook.materialize_pending_style_components](https://promptlytechnologies.com/fastpyxl/reference/Workbook.materialize_pending_style_components.html)
- [Workbook.copy_worksheet](https://promptlytechnologies.com/fastpyxl/reference/Workbook.copy_worksheet.html)
- [Workbook.close](https://promptlytechnologies.com/fastpyxl/reference/Workbook.close.html)

#### Functions
> Utility functions

- [cell.WriteOnlyCell](https://promptlytechnologies.com/fastpyxl/reference/cell.WriteOnlyCell.html)
- [chart.Series](https://promptlytechnologies.com/fastpyxl/reference/chart.Series.html)
- [compat.deprecated](https://promptlytechnologies.com/fastpyxl/reference/compat.deprecated.html)
- [compat.safe_string](https://promptlytechnologies.com/fastpyxl/reference/compat.safe_string.html)
- [load_workbook](https://promptlytechnologies.com/fastpyxl/reference/load_workbook.html): Open the given filename and return the workbook
- [open](https://promptlytechnologies.com/fastpyxl/reference/open.html): Open the given filename and return the workbook
- [styles.is_builtin](https://promptlytechnologies.com/fastpyxl/reference/styles.is_builtin.html)
- [styles.is_date_format](https://promptlytechnologies.com/fastpyxl/reference/styles.is_date_format.html)
- [styles.is_timedelta_format](https://promptlytechnologies.com/fastpyxl/reference/styles.is_timedelta_format.html)
- [typed_serialisable.AliasField](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.AliasField.html)
- [typed_serialisable.explicit_none_element](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.explicit_none_element.html)
- [xml.defusedxml_available](https://promptlytechnologies.com/fastpyxl/reference/xml.defusedxml_available.html)
- [xml.defusedxml_env_set](https://promptlytechnologies.com/fastpyxl/reference/xml.defusedxml_env_set.html)
- [xml.lxml_available](https://promptlytechnologies.com/fastpyxl/reference/xml.lxml_available.html)
- [xml.lxml_env_set](https://promptlytechnologies.com/fastpyxl/reference/xml.lxml_env_set.html)

#### Constants
> Module-level constants and data

- [compat.NUMERIC_TYPES](https://promptlytechnologies.com/fastpyxl/reference/compat.NUMERIC_TYPES.html)
- [styles.DEFAULT_FONT](https://promptlytechnologies.com/fastpyxl/reference/styles.DEFAULT_FONT.html)
- [typed_serialisable.Field](https://promptlytechnologies.com/fastpyxl/reference/typed_serialisable.Field.html)
- [xml.DEFUSEDXML](https://promptlytechnologies.com/fastpyxl/reference/xml.DEFUSEDXML.html)
- [xml.LXML](https://promptlytechnologies.com/fastpyxl/reference/xml.LXML.html)

#### Other
> Additional exports

- [packaging](https://promptlytechnologies.com/fastpyxl/reference/packaging.html): Stuff related to Office OpenXML packaging: relationships, archive, content types
- [pivot](https://promptlytechnologies.com/fastpyxl/reference/pivot.html)
- [reader](https://promptlytechnologies.com/fastpyxl/reference/reader.html)
- [workbook.Workbook](https://promptlytechnologies.com/fastpyxl/reference/workbook.Workbook.html)
- [worksheet](https://promptlytechnologies.com/fastpyxl/reference/worksheet.html)
- [writer](https://promptlytechnologies.com/fastpyxl/reference/writer.html)