Aspose.Words for Docling plugin

Purpose Summary. What is this page about?

This page describes the Aspose.Words for Docling plugin, including its features, installation steps, API usage, licensing requirements, and how to run its tests.

Aspose.Words for Docling is a free plugin for Docling based on Aspose.Words for Python via .Net commercial library.
The plugin is designed for parsing multiple document formats and converting them into Docling Documents suitable for AI processing.
You can find the project source code in the GitHub repository.

Features

Aspose.Words for Docling supports the following features:

Convert .doc, .rtf, .docx, .pdf, .html, .mhtml, .mobi, .azw3, .epub, .odt, .txt, .md and .xml to DoclingDocument.
Support all document components, including paragraphs, tables, images, headers, and footers.

Requirements

Docling version 2.60.0 or higher.
Aspose.Words for Python via .Net. This library is a commercial product.
You’ll need to obtain a valid license for Aspose.Words. The package will install this dependency, but you’re responsible for complying with Aspose’s licensing terms.

How to Install Aspose.Words for Docling

To install Aspose.Words for Docling via pip, run the following:

pip install aspose-words-docling

How to Use Aspose.Words for Docling

  
from aspose_words_docling import AsposeWordsConverter

aspose_converter = AsposeWordsConverter()
docling_document = aspose_converter.convert("test.doc")

md = docling_document.export_to_markdown()
print(md)

Aspose.Words License

This package is licensed under the MIT License. However, it depends on Aspose.Words for Python via .Net library, which is proprietary, closed-source library.

You must obtain valid license for Aspose.Words for Python via .Net library. This repository does not include or distribute any proprietary components.

To activate your Aspose.Words for Python license, set the corresponding environment variable.

Refer to the OS-specific instructions below:

Unix-based (Linux/macOS):

export ASPOSE_WORDS_LICENSE_PATH="/path/to/license/aspose.words.lic"

Windows-based:

set ASPOSE_WORDS_LICENSE_PATH=c:\path\to\license\aspose.words.lic

Python API:

  
from aspose_words_docling import LicenseManager
LicenseManager().apply_license("/path/to/license/aspose.words.lic")

How to Run Tests

To run unit tests for Aspose.Words for Docling, follow these steps:

Navigate to the package directory. From the root of the repository, change into the package directory:

cd /packages/aspose-words-docling/tests

Install test dependencies. Make sure pytest is installed:

pip install pytest

Run all the tests using pytest:

pytest

FAQ

Q: Can a Aspose.Total.NET license be used with the Aspose.Words for Python via .Net library?
A: No. A license file that is issued for the .NET version of Aspose.Total (e.g., Aspose.Total.NET.lic) is not valid for the Aspose.Words for Python via .Net library. You must obtain a license specifically for Aspose.Words for Python via .Net. Using a .NET‑only license will result in a “license is not valid for this product” error.
Q: How do I apply the Aspose.Words license when using the Docling plugin in Python?
A: Set the environment variable ASPOSE_WORDS_LICENSE_PATH to the full path of your aspose.words.lic file, or call the helper class provided by the plugin:
```
from aspose_words_docling import LicenseManager
LicenseManager().apply_license("/path/to/license/aspose.words.lic")
```
This must be done before any conversion operation is executed.
Q: Why do I receive the error “RuntimeError: Proxy error(InvalidOperationException): The license is not valid for this product.”?
A: This error occurs when the license file does not match the product you are using. Common causes are: using a .NET‑only license, using an expired or corrupted license file, or the license file not being found at the path specified by the environment variable. Verify that you are using a valid Aspose.Words for Python via .Net license and that the path is correct.
Q: Does the Docling plugin require a separate license from the Aspose.Words library?
A: No. The plugin itself is open‑source and distributed under the MIT license. It only depends on the commercial Aspose.Words for Python via .Net library, so you need a license only for that library, not for the plugin.