Python extension header file

A header file is a text file with the extension “.pyplugin” that configures the extension. The path to the header file relative to the root directory is the unique ID of the extension.

The header file contains several options to configure the extension:

NameName of the extension visible to the user.
ModuleThe name of the python file to execute (excluding the “.py” file extension).
CommentA longer description of the extension.
PythonEnvName of the python runtime environment to use.

Most importantly, the header file defines what python module to run, in what runtime environment.

The path and name of the header file, relative to the extension root directory, is the unique identity of the extension. E.g. when the user configures a report using a query extension, the ID of the extension is stored so the same extension is loaded when the report executes.