ODFPY - OpenDocument Python API

Warnings

• gotcha The official documentation for ODFPy is often described as highly technical and lacking in conceptual examples, making it challenging for newcomers. Users frequently resort to studying the provided examples and source code to understand usage patterns.
  Fix: Refer to the examples provided in the GitHub repository (https://github.com/eea/odfpy/tree/master/examples) and consider blog posts or third-party tutorials for practical usage. Examining the generated XML of simple documents can also aid understanding.
• gotcha While officially considered 'active maintenance', ODFPy has an infrequent release cycle (latest release 1.4.1 in January 2020). For projects requiring more frequent updates or active development, alternatives like `odfdo` (also listed by The Document Foundation) might be considered.
  Fix: Evaluate project needs against the library's release cadence. If cutting-edge features or rapid bug fixes are critical, investigate `odfdo` or other ODF manipulation libraries.
• gotcha ODFPy rigorously enforces OpenDocument Specification 1.2 through grammar checks. This means attempts to add invalid elements, unknown attributes, or text to unsupported elements will raise exceptions, preventing the creation of malformed documents. This strictness can be a 'gotcha' for users expecting more lenient XML handling.
  Fix: Familiarize yourself with the OpenDocument Specification structure or create minimal ODF documents manually in LibreOffice/OpenOffice and inspect their XML content to understand valid structures when encountering validation errors. The error messages usually provide clues about the specific ODF rule violated.
• gotcha Many examples and the library's design are more geared towards *creating* new ODF documents rather than *reading* and parsing content from existing ones. Finding clear, simple examples for extracting data from existing .odt or .ods files can be challenging.
  Fix: For reading existing ODF files, be prepared to explore the document's XML structure (e.g., `doc.getElementsByType(P)`) and iterate through elements. Community-contributed examples (like the `read-ods-with-odfpy` project on GitHub) might offer more insights into reading patterns.
• deprecated Older documentation and examples might point to the `joinup.ec.europa.eu` domain. This source is obsolete and should not be used for current information or downloads.
  Fix: Always refer to the official GitHub repository (https://github.com/eea/odfpy) and PyPI page (https://pypi.org/project/odfpy/) for the most up-to-date information, documentation, and examples.

Install

• pip install odfpy Install latest version

Imports

• OpenDocumentText

  from odf.opendocument import OpenDocumentText

  Used for creating new ODT documents.
• load

  from odf.opendocument import load

  Used for loading existing ODF documents.
• P

  from odf.text import P

  Used for creating paragraphs.
• Style

  from odf.style import Style

  Used for defining custom styles.
• teletype

  from odf import teletype

  Module for handling text insertion with proper whitespace handling.

Quickstart

This quickstart demonstrates how to create a simple OpenDocument Text (.odt) file, add a paragraph with text, and save the document using ODFPy. This is a common starting point for generating new ODF files.

from odf.opendocument import OpenDocumentText
from odf.text import P
import os

# Create a new ODT document
textdoc = OpenDocumentText()

# Create a paragraph and add some text
p = P(text="Hello, ODFPy World!")

# Add the paragraph to the document's text body
textdoc.text.addElement(p)

# Save the document to 'helloworld.odt'
# The 'prettyprint=True' argument formats the XML for readability.
try:
    output_filename = os.path.join(os.getcwd(), "helloworld.odt")
    textdoc.save(output_filename, prettyprint=True)
    print(f"Document '{output_filename}' created successfully.")
except Exception as e:
    print(f"Error saving document: {e}")