Skip to main content

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

Project description

https://travis-ci.org/chfw/pyexcel-ods.svg?branch=v0.0.5 https://codecov.io/github/chfw/pyexcel-ods/coverage.svg?branch=v0.0.5 https://pypip.in/d/pyexcel-ods/badge.png https://pypip.in/version/pyexcel-ods/badge.png https://pypip.in/py_versions/pyexcel-ods/badge.png https://pypip.in/implementation/pyexcel-ods/badge.png http://img.shields.io/gittip/chfw.svg

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

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install it via pip:

$ pip install pyexcel-ods

or clone it and install it:

$ git clone http://github.com/chfw/pyexcel-ods.git
$ cd pyexcel-ods
$ python setup.py install

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_ods 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_ods 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_ods 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 ods

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 ods
>>> 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

License

New BSD License

Dependencies

  1. odfpy

Credits

ODSReader is originally written by Marco Conti

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyexcel-ods, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size pyexcel-ods-0.0.5.tar.gz (5.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page