utils.rcclient.libs.dataapp_generator.dataapp_generator

Module Contents

Classes

DataappGenerator

Class that generates a dataapp template based on the provided app type.

Attributes

logger

utils.rcclient.libs.dataapp_generator.dataapp_generator.logger
class utils.rcclient.libs.dataapp_generator.dataapp_generator.DataappGenerator

Class that generates a dataapp template based on the provided app type.

scaffold
classmethod generate_app_template(name: str, display_name: str = None, description: str = None, source: utils.rcclient.enums.AppTemplateSource = AppTemplateSource.TENANT, path: str = os.path.dirname(os.path.abspath(__file__)), env_type: utils.rc.dtos.env.EnvType = EnvType.EXTRA_SMALL, status: utils.rcclient.enums.Status = Status.ACTIVE, app_type: utils.rcclient.enums.AppType = AppType.STREAMLIT, auto_ml_problem_type: utils.rcclient.enums.AutoMlProblemType = None) → utils.rcclient.entities.app_template.AppTemplate

Generates a dataapp template based on the provided app type.

Parameters:

  • name (str) – The name of the dataapp.

  • display_name (str, optional) – The display name of the dataapp. Defaults to None.

  • description (str, optional) – The description of the dataapp. Defaults to None.

  • source (AppTemplateSource, optional) – Whether the app template is global or not. Defaults to SYSTEM.

  • path (str, optional) – The path where the dataapp template should be generated. Defaults to the current file path.

  • env_type (EnvType, optional) – The environment type of the dataapp. Defaults to EnvType.EXTRA_SMALL.

Returns:

The generated dataapp object.

Return type:

Dataapp

Raises:

  • AssertionError – If the app name is empty.

  • AppGenerationFailed – If the dataapp generation failed.

classmethod __generate_scaffold(name: str, path: str, app_type: utils.rcclient.enums.AppType) → str