Add support for custom LibreOffice executable path

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## rtflite 2.3.1
+
+### New features
+
+- Added `executable_path` parameter to write_docx() method.
+- Added `/tmp/soffice` and `/tmp/libreoffice` paths for Linux.
+
 ## rtflite 2.3.0
 
 ### New features

docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## rtflite 2.3.1
+
+### New features
+
+- Added `executable_path` parameter to write_docx() method.
+- Added `/tmp/soffice` and `/tmp/libreoffice` paths for Linux.
+
 ## rtflite 2.3.0
 
 ### New features

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rtflite"
-version = "2.3.0"
+version = "2.3.1"
 description = "Lightweight RTF composer for Python"
 authors = [
     { name = "Yilong Zhang", email = "[email protected]" },

src/rtflite/dictionary/libreoffice.py

@@ -7,6 +7,8 @@
         "/Applications/LibreOffice.app/Contents/MacOS/soffice",
     ],
     "Linux": [
+        "/tmp/soffice",
+        "/tmp/libreoffice",
         "/usr/bin/soffice",
         "/usr/bin/libreoffice",
         "/snap/bin/libreoffice",

src/rtflite/encode.py

@@ -446,7 +446,9 @@ def write_rtf(self, file_path: str | Path) -> None:
         rtf_code = self.rtf_encode()
         target_path.write_text(rtf_code, encoding="utf-8")
 
-    def write_docx(self, file_path: str | Path) -> None:
+    def write_docx(
+        self, file_path: str | Path, executable_path: str | None = None
+    ) -> None:
         """Write the document as a DOCX file.
 
         Writes the document to a temporary RTF file first, and then converts
@@ -458,6 +460,8 @@ def write_docx(self, file_path: str | Path) -> None:
             file_path: Destination path for the DOCX file.
                 Accepts string or Path input. Can be absolute or relative.
                 Directories are created if they do not already exist.
+            executable_path: Optional path to the LibreOffice executable.
+                If not provided, the default system path will be used.
 
         Examples:
             ```python
@@ -476,7 +480,7 @@ def write_docx(self, file_path: str | Path) -> None:
             rtf_code = self.rtf_encode()
             rtf_path.write_text(rtf_code, encoding="utf-8")
 
-            converter = LibreOfficeConverter()
+            converter = LibreOfficeConverter(executable_path=executable_path)
             with tempfile.TemporaryDirectory() as convert_tmpdir:
                 docx_path = converter.convert(
                     input_files=rtf_path,

tests/test_write_docx_args.py

@@ -0,0 +1,47 @@
+from pathlib import Path
+from unittest.mock import patch
+
+import polars as pl
+import pytest
+
+from rtflite.encode import RTFDocument
+from rtflite.input import RTFBody, RTFTitle
+
+
+@pytest.fixture
+def sample_document() -> RTFDocument:
+    """Create a small RTFDocument for DOCX export tests."""
+    df = pl.DataFrame({"A": ["alpha"]})
+    return RTFDocument(
+        df=df,
+        rtf_title=RTFTitle(text="Sample Title"),
+        rtf_body=RTFBody(col_rel_width=[1]),
+    )
+
+
+@patch("rtflite.encode.LibreOfficeConverter")
+def test_write_docx_passes_executable_path(
+    mock_converter_cls, sample_document, tmp_path
+):
+    """Verify that executable_path is correctly passed to LibreOfficeConverter."""
+    # Setup mock
+    mock_instance = mock_converter_cls.return_value
+    mock_instance.convert.return_value = Path("dummy.docx")
+
+    # Create dummy docx file that would be moved
+    output_path = tmp_path / "output.docx"
+
+    # We need to mock shutil.move as well since the converter is mocked
+    # and won't actually create files
+    with patch("shutil.move"):
+        sample_document.write_docx(
+            output_path, executable_path="/custom/path/to/soffice"
+        )
+
+    # Verify LibreOfficeConverter was initialized with the correct path
+    mock_converter_cls.assert_called_once_with(
+        executable_path="/custom/path/to/soffice"
+    )
+
+    # Verify convert was called
+    mock_instance.convert.assert_called_once()