Skip to main content

pyexcel-odsr - Let you focus on data, instead of ods format

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg https://travis-ci.org/pyexcel/pyexcel-odsr.svg?branch=master https://codecov.io/gh/pyexcel/pyexcel-odsr/branch/master/graph/badge.svg https://badge.fury.io/py/pyexcel-odsr.svg https://pepy.tech/badge/pyexcel-odsr/month https://img.shields.io/gitter/room/gitterHQ/gitter.svg https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square

pyexcel-odsr is a specialized ods reader based on tailored ods reader from messytables. You are likely to use it with pyexcel. Differring from pyexcel-ods and pyexcel-ods3 in handling ods file, this library could read partial content from a huge ods file.

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on github, patreon or bounty source to maintain the project and develop it further.

If you are an individual, you are welcome to support me too and for however long you feel like. As my backer, you will receive early access to pyexcel related contents.

And your issues will get prioritized if you would like to become my patreon as pyexcel pro user.

With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install pyexcel-odsr via pip:

$ pip install pyexcel-odsr

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-odsr.git
$ cd pyexcel-odsr
$ python setup.py install

Usage

As a standalone library

Read from an ods file

Here’s the sample code:

>>> from pyexcel_odsr 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"]]}

Read from an ods from memory

Continue from previous example:

>>> # 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]]}

Pagination feature

Let’s assume the following file is a huge ods file:

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

And let’s pretend to read partial data:

>>> 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]]}

And you could as well do the same for columns:

>>> 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]]}

Obvious, you could do both at the same time:

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

Reading from an ods file

Here is the sample code:

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

Reading from a IO instance

You got to wrap the binary content with stream to get ods working:

>>> # 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 |
+-------+-------+-------+

License

New BSD License

Developer guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-odsr.git

  2. cd pyexcel-odsr

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install –upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists

  2. pip install -r requirements.txt

  3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant documentation and update CHANGELOG.rst.

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.

Credits

This library is based on the ods of messytables, Open Knowledge Foundation Ltd.

1 contributors

In alphabetical order:

Change log

0.6.0 - 10.10.2020

Updated

  1. New style xlsx plugins, promoted by pyexcel-io v0.6.2.

0.5.2 - 23.10.2017

updated

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

  2. remove python2.6 test support

  3. update its dependecy on pyexcel-io to 0.5.3

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

  2. #4, handle unseekable stream given by http response.

0.4.3 - 25.08.2017

Relocated

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

  2. #4, handle unseekable stream given by http response.

0.4.2 - 20.08.2017

0.4.1 - 26.07.2017

Updated

  1. PR #3, support fods, flat ods file

0.4.0 - 19.06.2017

Updated

  1. Updated to use lml interface

0.3.2 - 07.05.2017

Updated

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

0.3.1 - 13.04.2017

Updated

  1. issue #1, PT288H00M00S is valid duration

  2. initial release. It has all functionalities of pyexcel-ods and pyexcel-ods3. Specially, it supports partial reading of the ods file. When dealing with big data file, this capability enables pagination feature to indeed read partial files.

0.3.0 - 02.02.2017

Updated

  1. issue #1, PT288H00M00S is valid duration

  2. initial release. It has all functionalities of pyexcel-ods and pyexcel-ods3. Specially, it supports partial reading of the ods file. When dealing with big data file, this capability enables pagination feature to indeed read partial files.

Metadata

Release files for pyexcel-odsr 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyexcel-odsr 0.6.0
File Size Uploaded Provenance Actions
pyexcel-odsr-0.6.0.tar.gz 16.3 kB Without provenance Details for pyexcel-odsr-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyexcel-odsr 0.6.0
File Interpreter ABI Platform Actions
pyexcel_odsr-0.6.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for pyexcel_odsr-0.6.0-py2.py3-none-any.whl

Total release size: 27.6 kB

Release files / pyexcel-odsr-0.6.0.tar.gz

Download URL pyexcel-odsr-0.6.0.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1e7c6bba796ad20bdb4e999f8740055ba0235372e5afb78c90f75614e3f0c502
BLAKE2b-256 checksum
How to use checksums
c277588a2561d133e7c6b089126031c613b3592c11dea66e855189d44f2c9baa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

Release files / pyexcel_odsr-0.6.0-py2.py3-none-any.whl

Download URL pyexcel_odsr-0.6.0-py2.py3-none-any.whl
Size 11.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
51650c71838a8026b851dc426f2beaced031b096cc3f30137850407d86c643d3
BLAKE2b-256 checksum
How to use checksums
60cc447b38791bec0653b17c9931f8b68617cdc16528c18c53841b606b1686b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

Security for pyexcel-odsr 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page