Skip to main content

Interacting with using UNO

Project description

UnoTools allows you to interact with using the “UNO bridge”. The aim is to make handling OpenDocument easy than using the original UNO/PyUNO for scripting.

The unotools is quite simple, but you ought to understand UNO APIs.

There’re other tools.

How to install


  • 3.4 or lator

  • Python 3.3 or lator

On Ubuntu 14.04

Install libreoffice, uno library and python3:

$ sudo aptitude install -y libreoffice libreoffice-script-provider-python uno-libs3 python3-uno python3

I like virtualenvwrapper to make temporary environment:

$ sudo aptitude install -y virtualenvwrapper
$ mkvirtualenv -p /usr/bin/python3.4 --system-site-packages tmp3

Confirm importing uno module:

(tmp3)$ python
Python 3.4.0 (default, Apr 11 2014, 13:05:11)
[GCC 4.8.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import uno

Install unotools from PyPI:

(tmp3)$ pip install unotools

On Mac OS X

Download LibreOffice DMG package from and install.

$ hg clone ssh://

In Python 3.3 case, need singledispatch package. Confirm Python interpreter version included in LibreOffice.

$ hg clone ssh://

Set PYTHONPATH to resolve additional packages in LibreOffice’s Python interpreter.

$ export PYTHONPATH="/path/to/singledispatch/:/path/to/unotools/"

On Mac OS X, soffice and python commands are as below.

$ /Applications/ --version
LibreOffice de093506bcdc5fafd9023ee680b8c60e3e0645d7

Confirm importing unotools package:

$ /Applications/
Python 3.3.5 (default, Jan 22 2015, 17:12:45)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.51)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import unotools

How to use (on Ubuntu 14.04)

Startup libreoffice:

(tmp3)$ soffice --accept='socket,host=localhost,port=8100;urp;StarOffice.Service'

Download sample-scripts from

(tmp3)$ python sample-scripts/ -s localhost
(tmp3)$ python sample-scripts/ -s localhost -d sample-scripts/datadir/
(tmp3)$ ls
sample-calc.html  sample-calc.pdf  sample-calc_html_eaf26d01.png
sample-scripts  sample-writer.html  sample-writer.pdf
sample.csv  sample.doc  sample.ods  sample.odt  sample.xls

There’s a sample script to convert odt/ods to pdf.

(tmp3)$ python sample-scripts/ -s localhost -f sample.odt
(tmp3)$ python sample-scripts/ -s localhost -f sample.ods
(tmp3)$ ls sample.pdf

Look through these sample script, then it help you how to use unotools.

Interact with interpreter step by step

Interacting documents with UNO make you learn how to use unotools.

Startup LibreOffice:

$ soffice --accept='socket,host=localhost,port=8100;urp;StarOffice.Service'
>>> from unotools import Socket, connect
>>> from unotools.component.writer import Writer
>>> context = connect(Socket('localhost', 8100))
>>> writer = Writer(context)

Now, you can see new document window on LibreOffice.

>>> writer.set_string_to_end('Hello\n')
>>> writer.set_string_to_end('World\n')

Then, Hello and World are put into the document window.

>>> text = writer.text
>>> text
<unotools.component.writer.Text object at 0x1064a8e10>

Writer inherits XTextRange interface and has those methods. To make full use of unotools, you have to understand UNO APIs.

There’s a tip to confirm what methods are exist in the component. The _show_attributes() is a helper method that unotools component inherit.

>>> text._show_attributes()
[ ...

Though these methods are CamelCase, you can also invoke Python style methods.

>>> text.getString()

>>> text.get_string()

Both are same method and unotools component handles to convert Python style to original method.

Let’s save this document as odt.

>>> from unotools.unohelper import convert_path_to_url
>>> url = convert_path_to_url('./test1.odt')
>>> url
>>> writer.store_to_url(url, 'FilterName', 'writer8')
>>> writer.close(True)

If you want to read OpenDocument on file system, like this.

>>> writer = Writer(context, convert_path_to_url('./test1.odt'))


0.3.3 (2015-03-21)

  • added PDF conversion sample script

  • updated README as tutorial

0.3.2 (2014-06-07)

  • added some classes for calc

  • changed data directory option of command line argument (-d, –datadirs) to be able to store multiple directories

0.3.1 (2014-05-07)

  • added command line argument (-f, –file) to be able to read OpenDocument file

0.3.0 (2014-05-05)

  • first 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 Distribution

unotools-0.3.3.tar.gz (17.3 kB view hashes)

Uploaded Source

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