File Content Extraction 25.3
Filter SDK Python Programming Guide

# Before You Begin

## Install the Filter Python Module

The Filter Python module is in the `pythonapi` folder of the SDK. Install the module using Python's `pip` utility, as described below.

To install the Filter Python module

1. Open a command-line window.

2. Change directory to the SDK root directory.

3. Run the following command:

       pip install keyview-filter --no-index -f pythonapi/keyview

4. (Optional) To install optional components that are required to run the included Jupyter notebook, run the following command:

       pip install -r pythonapi/notebooks/requirements.txt

## Upgrade the Filter Python API

OpenText recommends that you use matching versions of the Filter Python API and the Filter binaries. If you upgrade either the python module or your File Content Extraction binaries, upgrade the other to match.

TIP: If you need to use several different versions of the Filter Python API, OpenText recommends that you create a separate Python environment for each version. You can do this using the Python `venv` module.

To check the Filter Python API version

- Run the following command:

      pip show keyview-filter

To upgrade the Filter Python API

- Run the following command, providing the path to the directory containing the latest version of the python module:

      pip install --upgrade keyview-filter --no-index -f pythonapi/keyview

Copyright 1997-2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: File Content Extraction 25.3

Topic Title: Before You Begin