pyexcel-ods3 0.0.6

A wrapper library to read, manipulate and write data in ods format

pyexcel-ods3 is a tiny wrapper library to read, manipulate and write data in ods fromat using python 2.7, python 3.3 and python 3.4. You are likely to use pyexcel together with this library. pyexcel-ods is a sister library that does the same thing but supports python 2.6 and has no dependency on lxml.

Known constraints

Only when the custom version of ezodf is installed, this library would (0.0.2+) support files in memory. pyexcel-ods3 v0.0.1 does not support memory file.

Fonts, colors and charts are not supported.

Installation

You can install it via pip:

$ pip install git+https://github.com/chfw/ezodf.git
$ pip install pyexcel-ods3

or clone it and install it:

$ pip install git+https://github.com/chfw/ezodf.git
$ pip install git+http://github.com/chfw/pyexcel-ods3.git
$ cd pyexcel-ods3
$ python setup.py install

The installation of lxml will be tricky on Widnows platform. It is recommended that you download a lxml’s own windows installer instead of using pip.

Usage

As a standalone library

Write to an ods file

Here’s the sample code to write a dictionary to an ods file:

>>> from pyexcel_ods3 import ODSWriter
>>> data = OrderedDict()
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
>>> writer = ODSWriter("your_file.ods")
>>> writer.write(data)
>>> writer.close()

Read from an ods file

Here’s the sample code:

>>> from pyexcel_ods3 import ODSBook
>>> book = ODSBook("your_file.ods")
>>> # book.sheets() returns a dictionary of all sheet content
>>> #   the keys represents sheet names
>>> #   the values are two dimensional array
>>> import json
>>> print(json.dumps(book.sheets()))
{"Sheet 1": [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], "Sheet 2": [["row 1", "row 2", "row 3"]]}

Write an ods file to memory

Here’s the sample code to write a dictionary to an ods file:

>>> from pyexcel_ods3 import ODSWriter
>>> data = OrderedDict()
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]})
>>> io = StringIO()
>>> writer = ODSWriter(io)
>>> writer.write(data)
>>> writer.close()
>>> # do something witht the io
>>> # In reality, you might give it to your http response
>>> # object for downloading

Read from an ods from memory

Here’s the sample code:

>>> # This is just an illustration
>>> # In reality, you might deal with xl file upload
>>> # where you will read from requests.FILES['YOUR_XL_FILE']
>>> book = ODSBook(None, io.getvalue())
>>> print(json.dumps(book.sheets()))
{"Sheet 1": [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], "Sheet 2": [[7.0, 8.0, 9.0], [10.0, 11.0, 12.0]]}

As a pyexcel plugin

Import it in your file to enable this plugin:

from pyexcel.ext import ods3

Please note only pyexcel version 0.0.4+ support this.

Reading from an ods file

Here is the sample code:

>>> import pyexcel as pe
>>> from pyexcel.ext import ods3
>>> sheet = pe.load_book("your_file.ods")
>>> sheet
Sheet Name: Sheet 1
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet Name: Sheet 2
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

Writing to an ods file

Here is the sample code:

>>> sheet.save_as("another_file.ods")

Reading from a StringIO instance

You got to wrap the binary content with StringIO to get odf working:

>>> # This is just an illustration
>>> # In reality, you might deal with xl file upload
>>> # where you will read from requests.FILES['YOUR_XL_FILE']
>>> xlfile = "another_file.ods"
>>> with open(xlfile, "rb") as f:
...     content = f.read()
...     r = pe.load_book_from_memory("ods", content)
...     print(r)
...
Sheet Name: Sheet 1
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet Name: Sheet 2
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

Writing to a StringIO instance

You need to pass a StringIO instance to Writer:

>>> data = [
...     [1, 2, 3],
...     [4, 5, 6]
... ]
>>> io = StringIO()
>>> sheet = pe.Sheet(data)
>>> sheet.save_to_memory("ods", io)
>>> # then do something with io
>>> # In reality, you might give it to your http response
>>> # object for downloading

Dependencies

1. ezodf