Welcome to the reference for the HyperX Scripting Application Programming Interface for Python. The HyperX Python package is a library, written in Python, for Python developers.

Basic usage:

import hyperx
database = hyperx.Open('mydatabase.hdb3')
print(f'Active project = {database.ActiveProject}')

The HyperX installation folder is found automatically if the installer was run. Otherwise, the installation folder can be specified by setting the environment variable HyperXInstall

import os
os.environ['HyperXInstall'] = 'C:/path/to/hyperx/installation'
import hyperx