App Base Class API

Last Updated: May 2024

Tethys apps are configured via the app class, which is contained in the app configuration file (app.py) of the app project. The app class must inherit from the TethysAppBase to be recognized by Tethys. This document contains API documentation for the TethysAppBase class.

Apps are configured in two ways using the app class to configure your app:

  • Properties

  • Method Overrides

In addition, the app class provides several class methods that can be used to get and set values of custom settings and connections to Tethys Services that are assigned to the app (e.g THREDDS/GeoServer, database connections, and schedulers).

Properties

Use these properties to set things like the display name, icon/logo, and theme color.

Override Methods

Override these methods (add them to your app class) to define objects that are used by the app such as Permissions, CustomSettings, and settings for Tethys Services that are required by your app.

Class Methods