Package: pyexcel-ods3
pyexcel-ods3is a tiny wrapper library to read, manipulate and write data in ods
format. You are likely to usepyexceltogether
with this library.pyexcel-odsis a sister
library that depends on GPL licensed odfpy.pyexcel-odsris the other sister library
that has no external dependency but do ods reading onlySupport 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.Nor to read password protected xls, xlsx and ods files.InstallationYou can install pyexcel-ods3 via pip:$pipinstallpyexcel-ods3or clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-ods3.git$cdpyexcel-ods3$pythonsetup.pyinstallUsageAs a standalone libraryWrite to an ods fileHere’s the sample code to write a dictionary to an ods file:>>>frompyexcel_ods3importsave_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)Read from an ods fileHere’s the sample code:>>>frompyexcel_ods3importget_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"]]}Write an ods to memoryHere’s the sample code to write a dictionary to an ods file:>>>frompyexcel_ods3importsave_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 downloadingRead 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 featureSpecial notice 30/01/2017: due to the constraints of the underlying 3rd party
library, it will read the whole file before returning the paginated data. So
at the end of day, the only benefit is less data returned from the reading
function. No major performance improvement will be seen.With that said, please installpyexcel-odsrand it gives better performance in pagination.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 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|+-------+-------+-------+Writing to an ods fileHere is the sample code:>>>sheet.save_as("another_file.ods")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|+-------+-------+-------+Writing to a StringIO instanceYou need to pass a StringIO instance to Writer:>>>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 downloadingLicenseNew BSD LicenseDeveloper guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-ods3.gitcd pyexcel-ods3Upgrade 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.ymlNoteAs 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, please issue this command:> test.batBefore you commitPlease run:$ make formatso as to beautify your code otherwise your build may fail your unit test.Installation NoteThe installation oflxmlwill be tricky on Windows platform. It is recommended that you download a lxml’s own windows installer instead of using pip.5 contributorsIn alphabetical order:Benedikt WaldvogelMateusz KoniecznyMichael K.Stephen J. FuhryVincent RaspalChange log0.6.1 - 1.2.2022added#28: support datetime0.6.0 - 8.10.2020addednew style reader and writer plugins. works with pyexcel-io v0.6.20.5.3 - 27.11.2018addedpyexcel#57, 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.2 - 23.10.2017updatedpyexcelpyexcel#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 module0.4.1 - 17.08.2017Updatedupdate dependency to use pyexcel-ezodf v0.3.3 as ezodf 0.3.2 hasthe bug, cannot handle file
alike objects and has not been updated for 2 years.0.4.0 - 19.06.2017Updatedpyexcel#14, close file
handlepyexcel-io plugin interface now updated to uselml.0.3.2 - 13.04.2017Updatedissuepyexcel#8,
PT288H00M00S is valid duration0.3.1 - 02.02.2017AddedRecognize currency type0.3.0 - 22.12.2016UpdatedCode refactoring with pyexcel-io v 0.3.00.2.2 - 05.11.2016Updatedpyexcel#11, be able to
consume a generator of two dimensional arrays.0.2.1 - 31.08.2016Addedsupport pagination. two pairs: start_row, row_limit and start_column,
column_limit help you deal with large files.0.2.0 - 01.06.2016AddedBy default,floatwill be converted tointwhere fits.auto_detect_int,
a flag to switch off the autoatic conversion fromfloattoint.‘library=pyexcel-ods3’ was added so as to inform pyexcel to use it instead of
other libraries, in the situation where multiple plugins for the same file
type are installedUpdatedsupport the auto-import feature of pyexcel-io 0.2.0compatibility with pyexcel-io 0.1.00.1.0 - 17.01.2016Updatedsupport the auto-import feature of pyexcel-io 0.2.0compatibility with pyexcel-io 0.1.0