pyexcel-ods 0.6.0

As a standalone library

>>> from pyexcel_ods import save_data
>>> data = OrderedDict() # from collections import OrderedDict
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
>>> save_data("your_file.ods", data)

>>> from pyexcel_ods import get_data
>>> data = get_data("your_file.ods")
>>> import json
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}

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

>>> # This is just an illustration
>>> # In reality, you might deal with ods file upload
>>> # where you will read from requests.FILES['YOUR_ODS_FILE']
>>> data = get_data(io)
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}

>>> huge_data = [
...     [1, 21, 31],
...     [2, 22, 32],
...     [3, 23, 33],
...     [4, 24, 34],
...     [5, 25, 35],
...     [6, 26, 36]
... ]
>>> sheetx = {
...     "huge": huge_data
... }
>>> save_data("huge_file.ods", sheetx)

>>> partial_data = get_data("huge_file.ods", start_row=2, row_limit=3)
>>> print(json.dumps(partial_data))
{"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}

>>> partial_data = get_data("huge_file.ods", start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}

>>> partial_data = get_data("huge_file.ods",
...     start_row=2, row_limit=3,
...     start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[23, 33], [24, 34], [25, 35]]}

As a pyexcel plugin

No longer, explicit import is needed since pyexcel version 0.2.2. Instead, this library is auto-loaded. So if you want to read data in ods format, installing it is enough.

>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.ods")
>>> sheet
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

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

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

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

How to test your contribution

Although nose and doctest are both used in code testing, it is adviable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows systems, please issue this command:

> test.bat

Before you commit

Please run:

$ make format

so as to beautify your code otherwise travis-ci may fail your unit test.

0.6.0 - 9.10.2020

added

1. new style reader and writer plugins. works with pyexcel-io v0.6.2

0.5.6 - 19.03.2019

added

1. #32, fix odfpy pinning

2. #33, fix IntegerAccuracyLossError on i586

0.5.5 - 16.03.2019

added

1. #32, fix odfpy pinning

0.5.4 - 27.11.2018

added

1. #30, long type will not be written in ods. please use string type. And if the integer is equal or greater than 10 to the power of 16, it will not be written either in ods. In both situation, IntegerPrecisionLossError will be raised.

0.5.3 - unreleased

added

1. #24, ignore comments(<office:comment>) in cell

2. #27, exception raised when currency type is missing

3. fix odfpy version on 1.3.5.

0.5.2 - 23.10.2017

updated

1. pyexcel pyexcel#105, remove gease from setup_requires, introduced by 0.5.1.

2. remove python2.6 test support

0.5.1 - 20.10.2017

added

1. pyexcel#103, include LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.

0.5.0 - 30.08.2017

Updated

1. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO. Hence, there will be performance boost in handling files in memory.

Relocated

1. All ods type conversion code lives in pyexcel_io.service module

0.4.1 - 25.08.2017

Updated

1. pyexcel#23, handle unseekable stream given by http response

2. PR #22, hanle white spaces in a cell.

0.4.0 - 19.06.2017

Updated

1. pyexcel#14, close file handle

2. pyexcel-io plugin interface now updated to use lml.

0.3.3 - 07.05.2017

Updated

1. issue pyexcel#19, not all texts in a multi-node cell were extracted.

0.3.2 - 13.04.2017

Updated

1. issue pyexcel#17, empty new line is ignored

2. issue pyexcel#6, PT288H00M00S is valid duration

0.3.1 - 02.02.2017

Added

1. Recognize currency type

0.3.0 - 22.12.2016

Updated

1. Code refactoring with pyexcel-io v 0.3.0

0.2.2 - 24.10.2016

Updated

1. issue pyexcel#14, index error when reading a ods file that has non-uniform columns repeated property.

0.2.1 - 31.08.2016

Added

1. support pagination. two pairs: start_row, row_limit and start_column, column_limit help you deal with large files.

2. use odfpy 1.3.3 as compulsory package. offically support python 3

0.2.0 - 01.06.2016

Added

1. By default, float will be converted to int where fits. auto_detect_int, a flag to switch off the autoatic conversion from float to int.

2. ‘library=pyexcel-ods’ was added so as to inform pyexcel to use it instead of other libraries, in the situation where multiple plugins were installed.

Updated

1. support the auto-import feature of pyexcel-io 0.2.0

0.1.1 - 30.01.2016

Added

1. ‘streaming’ is an extra option given to get_data. Only when ‘streaming’ is explicitly set to True, the data will be consisted of generators, hence will break your existing code.

2. uses yield in to_array and returns a generator

3. support multi-line text cell #5

4. feature migration from pyexcel-ods3 pyexcel/pyexcel-ods3#5

Updated

1. compatibility with pyexcel-io 0.1.1

0.0.12 - 10.10.2015

Updated

1. Bug fix: excessive trailing columns with empty values

0.0.11 - 26.09.2015

Updated

1. Complete fix for libreoffice datetime field

0.0.10 - 15.09.2015

Updated

1. Bug fix: date field could have datetime from libreoffice

0.0.9 - 21.08.2015

Updated

1. Bug fix: utf-8 string throw unicode exceptions

0.0.8 - 28.06.2015

Updated

1. Pin dependency odfpy 0.9.6 to avoid buggy odfpy 1.3.0

0.0.7 - 28.05.2015

Updated

1. Bug fix: “number-columns-repeated” is now respected

0.0.6 - 21.05.2015

Updated

1. get_data and save_data are seen across pyexcel-* extensions. remember them once and use them across all extensions.

0.0.5 - 22.02.2015

Added

1. Loads only one sheet from a multiple sheet book

2. Use New BSD License

0.0.4 - 14.12.2014

Updated

1. IO interface update as pyexcel-io introduced keywords.

2. initial release

0.0.3 - 08.12.2014

Updated

1. IO interface update as pyexcel-io introduced keywords.

2. initial release