python

Document Filters Python Samples

This repository contains samples and utilities for Document Filters, a set of tools for converting and processing various document formats. Explore the following directories and files to understand and use the capabilities of Document Filters.

Summary

The Document Filters Sample GitHub Repository includes:

• Samples for converting documents to different formats such as PDF, PNG, SVG, and more.
• Utilities for common tasks like extracting words from documents.
• A shared common library for Document Filters samples.

Explore the contents to leverage the power of Document Filters in your document processing projects.

To get started on your own project, check out the Getting Started section in the documentation.

Projects and Files

Name	Description
CombineDocuments.py	Combines multiple documents into a single multi-page document, with the ability to create an optional thumbnail page.
ConvertDocumentToHDHTML.py	Converts documents to high-definition, paginated HTML.
ConvertDocumentToPDF.py	Converts documents to PDF format.
ConvertDocumentToPNG.py	Converts documents to PNG format.
ConvertDocumentToStructuredXML.py	Converts documents to structured XML.
ConvertDocumentToTIFF.py	Converts documents to TIFF format.
ConvertDocumentToTIFFFromMemory.py	Converts documents to TIFF format from memory.
ConvertDocumentToTIFFStream.py	Converts documents to TIFF format using streams.
ConvertDocumentToUTF8.py	Converts documents to either text or flow-html. Additionally, sub-files can also be processed.
ConvertDocumentToUTF8WithOCR.py	Converts documents to text using Optical Character Recognition.
CreateBarcode.py	Demonstrates create 1D and 2D bar codes
ExtractAnnotations.py	Extracts annotations from documents.
ExtractDocumentWords.py	Retrieves words from documents.
WatermarkDocument.py	Converts a document to PDF and applies a watermark.
DocumentFiltersLicense.py	Update with your Document Filters License Key
DocumentFiltersSample.py	Utility functions for setup Document Filters objects.

Before You Begin

You will need to install the Document Filters Python bindings to be able to run the samples. To do so, run:

pip3 install -r requirements.txt

or

python -m pip install -r requirements.txt

Getting Started

You can run the sample applications without a license key, with some limitations. See Document Filters Evaluation for details.

To run the sample applications without feature limitations, ensure you have a valid Document Filters license key. You can provide this key by either modifying the DocumentFiltersLicense.py file or setting it in an environment variable named DF_LICENSE_KEY. Alternatively, you can pass the license key directly to the samples by specifying --license-key.

The samples can be run by passing to the python interpreter:

python ./ConvertDocumentToPDF.py "file.docx"

The sample will automatically download native libraries tailored for your platform, along with font assets, and store them in a runtimes directory.

Using in your application

You can install the DocumentFilters package as a fully integrated Python package, making it accessible to any Python project. To perform the installation, execute the following command:

python3 pip install "{bindings_dir}"

or add the dependency to your requirements.txt file.

git+https://github.com/Hyland/DocumentFilters.git@<desired-tag-or-branch>#egg=DocumentFilters&subdirectory=bindings/python

Replace <desired-tag-or-branch> with the specific tag or branch you want to use.

IMPORTANT: The package does not come bundled with the native shared libraries of Document Filters. It is essential to ensure that these files are accessible to the Operating System through its standard shared library resolution rules.

In these samples, this requirement is addressed by downloading the binaries into a runtime directory. Subsequently, the directory name is passed as the dll_path parameter during the invocation of the Initialize function.

Troubleshooting

libISYS11df.so: cannot open shared object file: No such file or directory

If you see an error similar to above, it means that Python was unable to locate the Document Filters Shared Libraries. Standard dlopen rules are used to locate the libraries.

This can often be worked around by adding the path containing the libraries to the LD_LIBRARY_PATH environment variable.