KeyView 24.4
KeyView Filter SDK Python Programming Guide

# Install the KeyView Filter Python Module

When you install the KeyView Filter SDK (see Windows Installation), the KeyView Filter Python module is extracted to the `pythonapi` folder. Install the module using Python's `pip` utility, as described below.

To install the KeyView Filter Python module

1. Open a command-line window.

2. Change directory to the KeyView installation 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 KeyView Filter Python API

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

TIP: If you need to use several different versions of the KeyView 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 KeyView Filter Python API version

- Run the following command:

      pip show keyview-filter

To upgrade the KeyView 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-2024 Open Text
Version 24.4 | Last updated September 2024

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: IDOL KeyView 24.4

Topic Title: Install the KeyView Filter Python Module