Skip to content

update io docs for OpenDocument Spreadsheets #49792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 22, 2022
Merged

update io docs for OpenDocument Spreadsheets #49792

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a890df0
update ODS docs
vamsi-verma-s Nov 19, 2022
6242169
minor fix
vamsi-verma-s Nov 19, 2022
2f5a9e5
fix again
vamsi-verma-s Nov 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions doc/source/user_guide/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3827,22 +3827,28 @@ format of an Excel worksheet created with the ``to_excel`` method. Excellent ex
OpenDocument Spreadsheets
-------------------------

.. versionadded:: 0.25

The :func:`~pandas.read_excel` method can also read OpenDocument spreadsheets
using the ``odfpy`` module. The semantics and features for reading
The io methods for `Excel files`_ also support reading and writing OpenDocument spreadsheets
using the `odfpy <https://pypi.org/project/odfpy/>`__ module. The semantics and features for reading and writing
OpenDocument spreadsheets match what can be done for `Excel files`_ using
``engine='odf'``.

.. versionadded:: 0.25

The :func:`~pandas.read_excel` method can read OpenDocument spreadsheets

.. code-block:: python

# Returns a DataFrame
pd.read_excel("path_to_file.ods", engine="odf")

.. note::
.. versionadded:: 1.1.0

Currently pandas only supports *reading* OpenDocument spreadsheets. Writing
is not implemented.
Similarly, the :func:`~pandas.to_excel` method can write OpenDocument spreadsheets

.. code-block:: python

# Writes DataFrame to a .ods file
df.to_excel("path_to_file.ods", engine="odf")

.. _io.xlsb:

Expand Down