pandas_ods_reader/README.md

47 lines
1.0 KiB
Markdown

pandas_ods_reader
===
Provides a function to read in an ODS file and returns a pandas DataFrame.
It uses `ezodf` to read in the ods file. If a range is specified in the sheet
to be imported, it seems that `ezodf` imports empty cells as well. Therefore,
completely empty rows and columns are dropped from the DataFrame, before it is
returned. Only trailing empty rows and columns are dropped.
Dependencies
---
- `ezodf`
- `lxml`
- `pandas`
Installation
---
`pip install pandas_ods_reader`
Usage
---
```Python
from pandas_ods_reader import read_ods
path = "path/to/file.ods"
# load a sheet based on its index (1 based)
sheet_idx = 1
df = read_ods(path, sheet_idx)
# load a sheet based on its name
sheet_name = "sheet1"
df = read_ods(path, sheet_name)
# load a file that does not contain a header row
# if no columns are provided, they will be numbered
df = read_ods(path, 1, headers=False)
# load a file and provide custom column names
# if headers is True (the default), the header row will be overwritten
df = read_ods(path, 1, columns=["A", "B", "C"])
```