Skip to main content

Simple Open Document Text templating tool

Project description

This is a minimal module for creating ODT files based on ODT templates and dictionaries of values.

Note that the template rendering is based on regular expression matches on the ODT internal XML data; as such it should not be considered robust and will most certainly fail on some inputs. However, it’s “good enough” to be very useful considering the tiny code footprint - there are more lines of documentation than code here!

Just be sure to test your templates…

Example::

from odt_template import render_odt_template

# Assuming a template that has:
#   - A @TO@ marker somewhere on the page
#   - A table with a row containing @CHILD@ and @NAUGHTY@ markers
#   - An embedded image named XMAS.png
#
render_odt_template('xmas-template.odt', 'simpsons-family.odt', {
    'to': 'Santa Claus',
    'child': [
        {'child': 'Bart', 'naughty': 'yes'},
        {'child': 'Lisa', 'naughty': 'no'},
        {'child': 'Maggie', 'naughty': 'no'}
    ],
    'Pictures/XMAS.png': open('pretty-tree.png', 'r').read()
})

Why doesn’t my template work?

LibreOffice has probably injected random formatting markup in the middle of your placeholders, preventing the tool from recognizing them. Using “Format, Clear Direct Formatting” and then reformatting again (taking care to always select entire placeholders) usually helps.

Contributions and bug reports

Please file pull requests or open issues on this project’s Github repository: https://github.com/BjarniRunar/odt-templater/

Project details


Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
odt_templater-0.1.2.tar.gz (3.9 kB) Copy SHA256 hash SHA256 Source None Apr 3, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page