{"id":19797396,"url":"https://github.com/pyexcel/pyexcel-ods3","last_synced_at":"2025-05-07T16:08:50.271Z","repository":{"id":21773294,"uuid":"25095577","full_name":"pyexcel/pyexcel-ods3","owner":"pyexcel","description":"pyexcel-ods3 reads, manipulates and writes data in ods formats using ezodf","archived":false,"fork":false,"pushed_at":"2025-04-18T07:47:15.000Z","size":332,"stargazers_count":68,"open_issues_count":6,"forks_count":13,"subscribers_count":4,"default_branch":"dev","last_synced_at":"2025-05-07T16:08:31.905Z","etag":null,"topics":["ods"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyexcel.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"chfw","patreon":"chfw"}},"created_at":"2014-10-11T21:15:02.000Z","updated_at":"2025-04-18T07:47:18.000Z","dependencies_parsed_at":"2022-08-17T19:35:24.537Z","dependency_job_id":null,"html_url":"https://github.com/pyexcel/pyexcel-ods3","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-ods3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-ods3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-ods3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-ods3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyexcel","download_url":"https://codeload.github.com/pyexcel/pyexcel-ods3/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252912996,"owners_count":21824066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ods"],"created_at":"2024-11-12T07:25:08.321Z","updated_at":"2025-05-07T16:08:50.256Z","avatar_url":"https://github.com/pyexcel.png","language":"Python","readme":"================================================================================\npyexcel-ods3 - Let you focus on data, instead of ods format\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n   :target: https://www.patreon.com/chfw\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg\n   :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-ods3/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/pyexcel/pyexcel-ods3\n\n.. image:: https://badge.fury.io/py/pyexcel-ods3.svg\n   :target: https://pypi.org/project/pyexcel-ods3\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-ods3/badges/version.svg\n   :target: https://anaconda.org/conda-forge/pyexcel-ods3\n\n\n.. image:: https://pepy.tech/badge/pyexcel-ods3/month\n   :target: https://pepy.tech/project/pyexcel-ods3\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-ods3/badges/downloads.svg\n   :target: https://anaconda.org/conda-forge/pyexcel-ods3\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n   :target: https://gitter.im/pyexcel/Lobby\n\n.. image:: https://img.shields.io/static/v1?label=continuous%20templating\u0026message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0\u0026color=blue\u0026style=flat-square\n    :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects\n\n.. image:: https://img.shields.io/static/v1?label=coding%20style\u0026message=black\u0026color=black\u0026style=flat-square\n    :target: https://github.com/psf/black\n\n**pyexcel-ods3** is a tiny wrapper library to read, manipulate and write data in ods\nformat. You are likely to use `pyexcel \u003chttps://github.com/pyexcel/pyexcel\u003e`__ together\nwith this library. `pyexcel-ods \u003chttps://github.com/pyexcel/pyexcel-ods\u003e`__ is a sister\nlibrary that depends on GPL licensed odfpy.\n`pyexcel-odsr \u003chttps://github.com/pyexcel/pyexcel-odsr\u003e`_ is the other sister library\nthat has no external dependency but do ods reading only\n\nSupport the project\n================================================================================\n\nIf your company uses pyexcel and its components in a revenue-generating product,\nplease consider supporting the project on GitHub or\n`Patreon \u003chttps://www.patreon.com/bePatron?u=5537627\u003e`_. Your financial\nsupport will enable me to dedicate more time to coding, improving documentation,\nand creating engaging content.\n\n\nKnown constraints\n==================\n\nFonts, colors and charts are not supported.\n\nNor to read password protected xls, xlsx and ods files.\n\nInstallation\n================================================================================\n\n\nYou can install pyexcel-ods3 via pip:\n\n.. code-block:: bash\n\n    $ pip install pyexcel-ods3\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n    $ git clone https://github.com/pyexcel/pyexcel-ods3.git\n    $ cd pyexcel-ods3\n    $ python setup.py install\n\nUsage\n================================================================================\n\nAs a standalone library\n--------------------------------------------------------------------------------\n\n.. testcode::\n   :hide:\n\n    \u003e\u003e\u003e import os\n    \u003e\u003e\u003e import sys\n    \u003e\u003e\u003e from io import BytesIO\n    \u003e\u003e\u003e from collections import OrderedDict\n\n\nWrite to an ods file\n********************************************************************************\n\n\n\nHere's the sample code to write a dictionary to an ods file:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from pyexcel_ods3 import save_data\n    \u003e\u003e\u003e data = OrderedDict() # from collections import OrderedDict\n    \u003e\u003e\u003e data.update({\"Sheet 1\": [[1, 2, 3], [4, 5, 6]]})\n    \u003e\u003e\u003e data.update({\"Sheet 2\": [[\"row 1\", \"row 2\", \"row 3\"]]})\n    \u003e\u003e\u003e save_data(\"your_file.ods\", data)\n\n\nRead from an ods file\n********************************************************************************\n\nHere's the sample code:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from pyexcel_ods3 import get_data\n    \u003e\u003e\u003e data = get_data(\"your_file.ods\")\n    \u003e\u003e\u003e import json\n    \u003e\u003e\u003e print(json.dumps(data))\n    {\"Sheet 1\": [[1, 2, 3], [4, 5, 6]], \"Sheet 2\": [[\"row 1\", \"row 2\", \"row 3\"]]}\n\n\nWrite an ods to memory\n********************************************************************************\n\nHere's the sample code to write a dictionary to an ods file:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from pyexcel_ods3 import save_data\n    \u003e\u003e\u003e data = OrderedDict()\n    \u003e\u003e\u003e data.update({\"Sheet 1\": [[1, 2, 3], [4, 5, 6]]})\n    \u003e\u003e\u003e data.update({\"Sheet 2\": [[7, 8, 9], [10, 11, 12]]})\n    \u003e\u003e\u003e io = BytesIO()\n    \u003e\u003e\u003e save_data(io, data)\n    \u003e\u003e\u003e # do something with the io\n    \u003e\u003e\u003e # In reality, you might give it to your http response\n    \u003e\u003e\u003e # object for downloading\n\n\n\n.. testcode::\n   :hide: \n\n    \u003e\u003e\u003e notneeded=io.seek(0)\n\nRead from an ods from memory\n********************************************************************************\n\nContinue from previous example:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e # This is just an illustration\n    \u003e\u003e\u003e # In reality, you might deal with ods file upload\n    \u003e\u003e\u003e # where you will read from requests.FILES['YOUR_ODS_FILE']\n    \u003e\u003e\u003e data = get_data(io)\n    \u003e\u003e\u003e print(json.dumps(data))\n    {\"Sheet 1\": [[1, 2, 3], [4, 5, 6]], \"Sheet 2\": [[7, 8, 9], [10, 11, 12]]}\n\n\nPagination feature\n********************************************************************************\n\nSpecial notice 30/01/2017: due to the constraints of the underlying 3rd party\nlibrary, it will read the whole file before returning the paginated data. So\nat the end of day, the only benefit is less data returned from the reading\nfunction. No major performance improvement will be seen.\n\nWith that said, please install `pyexcel-odsr \u003chttps://github.com/pyexcel/pyexcel-odsr\u003e`_\nand it gives better performance in pagination.\n\nLet's assume the following file is a huge ods file:\n\n.. code-block:: python\n\n   \u003e\u003e\u003e huge_data = [\n   ...     [1, 21, 31],\n   ...     [2, 22, 32],\n   ...     [3, 23, 33],\n   ...     [4, 24, 34],\n   ...     [5, 25, 35],\n   ...     [6, 26, 36]\n   ... ]\n   \u003e\u003e\u003e sheetx = {\n   ...     \"huge\": huge_data\n   ... }\n   \u003e\u003e\u003e save_data(\"huge_file.ods\", sheetx)\n\nAnd let's pretend to read partial data:\n\n.. code-block:: python\n\n   \u003e\u003e\u003e partial_data = get_data(\"huge_file.ods\", start_row=2, row_limit=3)\n   \u003e\u003e\u003e print(json.dumps(partial_data))\n   {\"huge\": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}\n\nAnd you could as well do the same for columns:\n\n.. code-block:: python\n\n   \u003e\u003e\u003e partial_data = get_data(\"huge_file.ods\", start_column=1, column_limit=2)\n   \u003e\u003e\u003e print(json.dumps(partial_data))\n   {\"huge\": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}\n\nObvious, you could do both at the same time:\n\n.. code-block:: python\n\n   \u003e\u003e\u003e partial_data = get_data(\"huge_file.ods\",\n   ...     start_row=2, row_limit=3,\n   ...     start_column=1, column_limit=2)\n   \u003e\u003e\u003e print(json.dumps(partial_data))\n   {\"huge\": [[23, 33], [24, 34], [25, 35]]}\n\n.. testcode::\n   :hide:\n\n   \u003e\u003e\u003e os.unlink(\"huge_file.ods\")\n\n\nAs a pyexcel plugin\n--------------------------------------------------------------------------------\n\nNo longer, explicit import is needed since pyexcel version 0.2.2. Instead,\nthis library is auto-loaded. So if you want to read data in ods format,\ninstalling it is enough.\n\n\nReading from an ods file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e import pyexcel as pe\n    \u003e\u003e\u003e sheet = pe.get_book(file_name=\"your_file.ods\")\n    \u003e\u003e\u003e sheet\n    Sheet 1:\n    +---+---+---+\n    | 1 | 2 | 3 |\n    +---+---+---+\n    | 4 | 5 | 6 |\n    +---+---+---+\n    Sheet 2:\n    +-------+-------+-------+\n    | row 1 | row 2 | row 3 |\n    +-------+-------+-------+\n\n\nWriting to an ods file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e sheet.save_as(\"another_file.ods\")\n\n\nReading from a IO instance\n********************************************************************************\n\nYou got to wrap the binary content with stream to get ods working:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e # This is just an illustration\n    \u003e\u003e\u003e # In reality, you might deal with ods file upload\n    \u003e\u003e\u003e # where you will read from requests.FILES['YOUR_ODS_FILE']\n    \u003e\u003e\u003e odsfile = \"another_file.ods\"\n    \u003e\u003e\u003e with open(odsfile, \"rb\") as f:\n    ...     content = f.read()\n    ...     r = pe.get_book(file_type=\"ods\", file_content=content)\n    ...     print(r)\n    ...\n    Sheet 1:\n    +---+---+---+\n    | 1 | 2 | 3 |\n    +---+---+---+\n    | 4 | 5 | 6 |\n    +---+---+---+\n    Sheet 2:\n    +-------+-------+-------+\n    | row 1 | row 2 | row 3 |\n    +-------+-------+-------+\n\n\nWriting to a BytesIO instance\n********************************************************************************\n\nYou need to pass a BytesIO instance to Writer:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e data = [\n    ...     [1, 2, 3],\n    ...     [4, 5, 6]\n    ... ]\n    \u003e\u003e\u003e io = BytesIO()\n    \u003e\u003e\u003e sheet = pe.Sheet(data)\n    \u003e\u003e\u003e io = sheet.save_to_memory(\"ods\", io)\n    \u003e\u003e\u003e # then do something with io\n    \u003e\u003e\u003e # In reality, you might give it to your http response\n    \u003e\u003e\u003e # object for downloading\n\n\nLicense\n================================================================================\n\nNew BSD License\n\nDeveloper guide\n==================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/pyexcel-ods3.git\n#. cd pyexcel-ods3\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update changelog.yml\n\n.. note::\n\n    As to rnd_requirements.txt, usually, it is created when a dependent\n    library is not released. Once the dependency is installed\n    (will be released), the future\n    version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n--------------------------------------------------------------------------------\n\nAlthough `nose` and `doctest` are both used in code testing, it is advisable\nthat unit tests are put in tests. `doctest` is incorporated only to make sure\nthe code examples in documentation remain valid across different development\nreleases.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n    $ make\n\nOn Windows, please issue this command::\n\n    \u003e test.bat\n\n\nBefore you commit\n------------------------------\n\nPlease run::\n\n    $ make format\n\nso as to beautify your code otherwise your build may fail your unit test.\n\n\nInstallation Note\n================================================================================\nThe installation of `lxml` will be tricky on Windows platform. It is recommended that you download a lxml's own windows installer instead of using pip.\n\n.. testcode::\n   :hide:\n\n   \u003e\u003e\u003e import os\n   \u003e\u003e\u003e os.unlink(\"your_file.ods\")\n   \u003e\u003e\u003e os.unlink(\"another_file.ods\")\n","funding_links":["https://github.com/sponsors/chfw","https://patreon.com/chfw","https://www.patreon.com/chfw","https://www.patreon.com/bePatron?u=5537627"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel%2Fpyexcel-ods3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyexcel%2Fpyexcel-ods3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel%2Fpyexcel-ods3/lists"}