Include Python Path Extension for LibreOffice

Include extra python paths for LibreOffice python scripts.

On LibreOffice Extensions this extension can be found here, locally the extension can is found in the dist folder.

After installing extension and restarting LibreOffice, the extension will be available in the Tools -> Extension Manager... dialog.

Windows Example Tutorial

Virtual Environment

Using pyenv for Windows set the environment for the local folder to match the Python major and minor version of LibreOffice.

In this example the folder is D:\Python\python38

pyenv local 3.8.10

Make a virtual environment in D:\Python\python38

python -m venv venv

Activate the virtual environment

.\venv\Scripts\Activate.ps1

Should see a prompt similar to:

(venv) [D:\Python\python38\]

Pip install python package(s) into the virtual environment.

pip install ooo-dev-tools

LibreOffice

Add Path

Start LibreOffice and open the extension manager Tools -> Extension Manager... Select LibreOffice Python Path Extension. Click on Options.

Select the Python Paths option page.

Choose Add Folder and navigate to the Location of the site-packages for the virtual environment that was set up previously.

Now the path is added to the extension.

Click OK and restart LibreOffice and the path will be added to LibreOffice when it starts.

APSO

Using the APSO console the import can be tested.

Dev Container

This project is generated from Python LibreOffice Pip Extension Template which in turn was generated from the Live LibreOffice Python Template This means this project can be run/developed in a Development container or Codespace with full access to LibreOffice.

Accessing LibreOffice

The ports to access LibreOffice are 3050 for http and 3051 for https.

See also: How do I access the LibreOffice in a GitHub Codespace? on Live LibreOffice Python Template.

Installing Extension

From LibreOffice open the extension manager, Tools -> Extension Manager ... and add PyPath.oxt

When prompted choose Only for me. Restart LibreOffice and extension will install.

Linking CPython files

This only apply to Mac OS and AppImage on Linux. On other versions of LibreOffice the Create Links... and Unlink.. buttons are not visible.

Mac Os and Linux AppImage installs of LibreOffice have an embedded version of python.

If the folder you are linking has no cpython files then this option is not needed.

The embedded version of Python can only import from binary files that are compiled for the embedded version of Python. However when pip installs packages that contain binary .so file it's name might be named something like bit_generator.cpython-38-x86_64-linux-gnu.so. The issue is that the embedded python cannot import from this version of the binary file. For LibreOffice embedded python 3.8.10 the file would need to be named bit_generator.cpython-3.8.so. This is the reason that numpy cannot be imported when installed via pip into Mac OS and Linux AppImage versions of LibreOffice.

The work around for this is to create symbolic links to each cpython binary in the selected folder and its subfolders. This extension will create the symbolic links for you. For example bit_generator.cpython-3.8.so would be a symbolic link that points to bit_generator.cpython-38-x86_64-linux-gnu.so and now LibreOffice python is able to import it.

With a folder selected in the Python Paths dialog, click on Create Links... and the extension will prompt you to create symbolic links in the selected folder and its subfolders.

For example before linking with numpy installed an the virtual environment. When trying to import numpy the following error is displayed.

No module named 'numpy.core._multiarray_umath' (or 'numpy.core._multiarray_umath.add_docstring' is unknown)
 (or '.core' is unknown)

After creating the links this issue is resolved.

To remove symbolic links use the Unlink.. button. It will prompt you to remove the symbolic links in the selected folder and its subfolders.

See also: Python bug 36716