Package: pyexcel-odsr
pyexcel-odsris a specialized ods reader based on tailored ods reader frommessytables.
You are likely to use it withpyexcel.
Differring frompyexcel-odsandpyexcel-ods3in handling ods file, this
library could read partial content from a huge ods file.Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, please support me on github,patreonorbounty sourceto 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 receiveearly access to pyexcel related contents.And your issues will get prioritized if you would like to become my patreon aspyexcel 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 constraintsFonts, colors and charts are not supported.InstallationYou can install pyexcel-odsr via pip:$pipinstallpyexcel-odsror clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-odsr.git$cdpyexcel-odsr$pythonsetup.pyinstallUsageAs a standalone libraryRead from an ods fileHere’s the sample code:>>>frompyexcel_odsrimportget_data>>>data=get_data("your_file.ods")>>>importjson>>>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 memoryContinue 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 featureLet’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 pluginNo 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 fileHere is the sample code:>>>importpyexcelaspe>>>sheet=pe.get_book(file_name="your_file.ods")>>>sheetSheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet2:+-------+-------+-------+|row1|row2|row3|+-------+-------+-------+Reading from a IO instanceYou 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">>>withopen(odsfile,"rb")asf:...content=f.read()...r=pe.get_book(file_type="ods",file_content=content)...print(r)...Sheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet2:+-------+-------+-------+|row1|row2|row3|+-------+-------+-------+LicenseNew BSD LicenseDeveloper guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-odsr.gitcd pyexcel-odsrUpgrade your setup tools and pip. They are needed for development and testing only:pip install –upgrade setuptools pipThen install relevant development requirements:pip install -r rnd_requirements.txt # if such a file existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs to rnd_requirements.txt, usually, it is created when a dependent
library is not released. Once the dependecy is installed
(will be released), the future
version of the dependency in the requirements.txt will be valid.How to test your contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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:$ makeOn Windows systems, please issue this command:> test.batBefore you commitPlease run:$ make formatso as to beautify your code otherwise travis-ci may fail your unit test.CreditsThis library is based on the ods of messytables, Open Knowledge Foundation Ltd.1 contributorsIn alphabetical order:JonaChange log0.6.0 - 10.10.2020UpdatedNew style xlsx plugins, promoted by pyexcel-io v0.6.2.0.5.2 - 23.10.2017updatedpyexcel#105, remove gease
from setup_requires, introduced by 0.5.1.remove python2.6 test supportupdate its dependecy on pyexcel-io to 0.5.30.5.1 - 20.10.2017addedpyexcel#103, include
LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
tar ball.0.5.0 - 30.08.2017Updatedput dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO.
Hence, there will be performance boost in handling files in memory.RelocatedAll ods type conversion code lives in pyexcel_io.service module#4, handle unseekable
stream given by http response.0.4.3 - 25.08.2017RelocatedAll ods type conversion code lives in pyexcel_io.service module#4, handle unseekable
stream given by http response.0.4.2 - 20.08.20170.4.1 - 26.07.2017UpdatedPR#3, support fods, flat
ods file0.4.0 - 19.06.2017UpdatedUpdated to use lml interface0.3.2 - 07.05.2017Updatedissue#2, not all texts
in a multi-node cell were extracted.0.3.1 - 13.04.2017Updatedissue#1, PT288H00M00S
is valid durationinitial 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.2017Updatedissue#1, PT288H00M00S
is valid durationinitial 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.