Application Configuration

An Xpress Insight Python app is implemented as a Python class which contains: meta-data about the app, definition of the data model, as well as definition of the execution modes.

import xpressinsight as xi

@xi.AppConfig(name="My First Insight Python App", version=xi.AppVersion(0, 1, 2))
class MyApp(xi.AppBase):

    # TODO: Declare data model here.

    # TODO: Define execution modes here.

In the above example, the MyApp class represents the main Insight Python app. Any name may be chosen for the class, but it must extend xpressinsight.AppBase and must be decorated by xpressinsight.AppConfig. Additionally, there must be exactly one such class per app.

The xpressinsight.AppConfig decorator allows the user to specify meta-data about the app such as the name and version. The name and version will appear on the Xpress Insight home page for the app. The version follows the "Semantic Versioning" guidelines of specifying the major, minor, and patch versions as non-negative integers between 0 and 999. In the above example, the version of the app is 0.1.2.

Extending xpressinsight.AppBase provides the primary functionality to interact with the Insight server, for example reading and writing attachment files.

App Configuration Classes