Python library for OpenDocument format (ODF)

odfdo is a Python3 library implementing the ISO/IEC 26300 OpenDocument Format standard.

Project: https://github.com/jdum/odfdo

Author: jerome.dumonteil@gmail.com

License: Apache License, Version 2.0

odfdo is a derivative work of the former lpod-python project.

Installation from Pypi (recommended):

pip install odfdo

Installation from sources (requiring setuptools):

pip install .

After installation, you can check everything is working (requirement: pytest):

cd test && pytest

The tests should run for a few seconds and issue no error.

from odfdo import Document, Paragraph

doc = Document('text')
doc.body.append(Paragraph("Hello world!"))
doc.save("hello.odt")

'Intended Audience :: Developers'

There is no detailed documentation or tutorial, but:

• the recipes folder contains more than 50 working sample scripts,
• the scripts folder contains some useful scripts (like style management),
• the doc folder contains an auto generated documentation.

About styles: the best way to apply style is by merging styles from a template document into your generated document. See odfdo-style.py in scripts folder. Styles are a complex matter in ODF, so trying to generate styles programmatically is not recommended.

odfdo is intended to facilitate the generation of ODF documents, nevertheless a basic knowledge of the ODF format is necessary.

ODF document rendering can vary greatly from software to software. Especially the "styles" of the document allow an adaptation of the rendering for a particular software.

The best (only ?) way to apply style is by merging styles from a template document into your generated document. See odfdo-style.pyexempale in the scripts folder.

I you work on .ods files (spreadsheet), you may be interested by these scripts that use this library to parse/generate .ods files: https://github.com/jdum/odsgenerator and https://github.com/jdum/odsparsator

lpod-python was written in 2009-2010 as a Python 2.x library, see: https://github.com/lpod/lpod-python

odfdo is an adaptation of this formaer project. odfdo main changes from lpod:

• odfdo requires, at least, Python version >= 3.6 (tested up to python 3.12).
• API change: more pythonic.
• include recipes.
• use Apache 2.0 license.