Skip to main content

A Fusion server that will transform your py3o.template into final LibreOffice documents

Project description


py3o.fusion is a web server that provides simple but important services:

  • transform your py3o.template LibreOffice templates into final LibreOffice documents.

  • transform OpenOffice / LibreOffice documents to any supported format

Basically you can fusion a templated OpenOffice / LibreOffice document into any supported format (odt, doc, docx, pdf)

This is intended to avoid direct dependencies in your own applications. This also opens up the py3o ecosystem to other programming languages than Python.


We recommend using the docker images we created. This is by far the quickest to get a full conversion service up and running without hassle.

Just follow the instructions from our page on the docker hub

Using it

You can use any language.

Here is the simplest example possible:

# import the wonderful requests lib
# if you need to intall it just try
# pip install --upgrade requests
import requests

# define where is your py3o.fusion endpoint
url = 'http://localhost:8765/form'

# open up the file and stuff it into a dictionary
# tmpl_file is a required field on the form. If you don't give
# it to the endpoint you'll receive an error back from it.
files = {
    'tmpl_file': open('templates/simple.odt', 'rb')

# then prepare the other fields of the form
# those 3 fields are also mandatory and failing to POST
# one of them will get you an error back from the server
# In this example you can see we leave the datadictionary
# and the image_mapping empty... This is because we won't
# send a template to the server but a simple plain
# old ODT file
fields = {
    "targetformat": 'pdf',
    "datadict": "{}",
    "image_mapping": "{}",

# finally POST our request on the endpoint
r =, data=fields, files=files)

# don't forget to close our orginal odt file

# see if it is a success or a failure
# ATM the server only returns 400 errors... this may change
if r.status_code == 400:
    # server says we have an error...
    # this means it properly catched the error and nicely
    # gave us some info in a JSON answer...
    # let's use this fact
    print r.json()

    # if we're here it is because we should receive a new
    # file back

    # let's stream the file back here...
    chunk_size = 1024

    # fusion server will stream an ODT file content back
    outname = 'request_out.%s' % 'pdf'
    with open(outname, 'wb') as fd:
        for chunk in r.iter_content(chunk_size):

    # warn our dear user his file is ready
    print "Your file: %s is ready" % outname

grab the full source from here and the example ODT from here here is a way to do this in one step:

$ mkdir -p templates && wget && wget && mv simple.odt templates/

Here is a more complicated example that fusions a datadictionary into a templated ODT using py3o.template and gives you back the resulting PDF. You’ll note you can also override an image inside the template:

# you'll need to install requests to make this example work
# pip install --upgrade requests
# should do the trick
import requests
import json

# point the client to your own py3o.fusion server
url = 'http://localhost:8765/form'

# target formats you want... can be ODT, PDF, DOC, DOCX
targetformats = ["odt", "pdf", "doc", "docx"]

class MyEncoder1(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, Item):
            obj = obj._asdict()
            obj = super(MyEncoder1, self).default(obj)

        return obj

class Item(object):
    def _asdict(self):
        return self.__dict__

items = list()

item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = '12345.35'
item1.InvoiceRef = '#1234'

for i in xrange(1000):
    item = Item()
    item.val1 = 'Item%s Value1' % i
    item.val2 = 'Item%s Value2' % i
    item.val3 = 'Item%s Value3' % i
    item.Currency = 'EUR'
    item.Amount = '6666.77'
    item.InvoiceRef = 'Reference #%04d' % i

document = Item() = '9999999999999.999'

data = dict(items=items, document=document)

data_s = json.dumps(data, cls=MyEncoder1)

for targetformat in targetformats:
    # open the files you need
    files = {
        'tmpl_file': open('templates/py3o_example_template.odt', 'rb'),
        'img_logo': open('images/new_logo.png', 'rb'),

    # fusion API needs those 3 keys
    fields = {
        "targetformat": targetformat,
        "datadict": data_s,
        "image_mapping": json.dumps({"img_logo": "logo"}),

    # and it needs to receive a POST with fields and files
    r =, data=fields, files=files)

    # TODO: handle error codes
    if r.status_code == 400:
        # server says we have a problem...
        # let's give the info back to our human friend
        print r.json()

        chunk_size = 1024
        # fusion server will stream an ODT file content back
        ext = targetformat.lower()
        with open('request_out.%s' % ext, 'wb') as fd:
            for chunk in r.iter_content(chunk_size):


And voila. You have a file called out.odt that contains the final odt fusionned with your data dictionary.

For the full source code + template file and images just download them from our repo

If you just want to test it rapidly you can also point your browser to the server http://localhost:8765/form and fill the form manually.


0.8 Jun. 03 2015

  • bugfix release to fix regression introduced in 0.7 concerning allowed formats calculation in case a renderserver is present. All 0.7 users wishing to use a renderserver (ie: produce non-native formats) should upgrade to 0.8

0.7 Jun. 02 2015

  • Internal refactoring that also changes public API, formats are now handled using py3o.formats instead of using internal functions. This changes format names the user must provide to be lower case instead of upper case. See for more information about all the supported formats and their names.

0.6 May. 29 2015

  • Now gracefully handle case when the caller does not provide an json payload

0.5 0ct. 15 2014

  • Added better logs (datetime, level, module, message)

  • Fixed rendering of non native formats broken by the skipflag

0.4 Oct. 14 2014

  • Added syntax coloration on features page

  • Added a new keyword to the POST options to skip the fusion step (ie: py3o.template -> plain odt). This is because in some case you only want to transform an already existing ODT file to some target format.

0.3 sep. 12 2014

  • Added examples that can be downloaded from the feature page of the server itself.

0.2 sep. 11 2014

  • Fixed an error case when the caller specified an invalid image mapping. The error was catched on the server but not sent back the the client.

0.1 sep. 11 2014

  • Initial release

Project details

Download files

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

Source Distributions (1.3 MB view hashes)

Uploaded Source

py3o.fusion-0.8.1.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distributions

py3o.fusion-0.8.1-py2.7.egg (1.3 MB view hashes)

Uploaded Source

py3o.fusion-0.8.1-py2-none-any.whl (1.3 MB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page