Example 2. v1 app with GUI

config.json for v1 app with GUI explained

Introduction

In this section we'll explain app config for Convert Class Shape app. This app converts labeled objects from one geometry to another and creates a new project from original with converted class shapes.

supervisely-ecosystem/convert-class-shape/config.json

{
  "name": "Convert Class Shape",
  "type": "app",
  "categories": [
    "images",
    "annotation transformation",
    "data operations"
  ],
  "description": "Converts shapes of classes (e.g. polygon to bitmap) and all corresponding objects",
  "docker_image": "supervisely/base-py-sdk:6.35.0",
  "instance_version": "6.4.57",
  "main_script": "src/convert_class_shape.py",
  "gui_template": "src/gui.html",
  "modal_template": "src/modal.html",
  "task_location": "workspace_tasks",
  "isolate": true,
  "icon": "https://i.imgur.com/TxR0dfX.png",
  "icon_background": "#FFFFFF",
  "context_menu": {
    "target": [
      "images_project"
    ],
    "context_category": "Transform"
  },
  "poster": "https://user-images.githubusercontent.com/106374579/186599439-6b6848e6-48cb-4fdc-912e-1a4493c79f41.png"
}

Properties

name

Name of the app in Supervisely

"name": "Convert Class Shape"

type

Entity type in Supervisely Ecosystem

"type": "app"

categories

Сategories under which the app will be displayed in Ecosystem

"categories": [
    "images",
    "annotation transformation",
    "data operations"
  ]

description

Description of the app in Supervisely

"description": "Converts shapes of classes (e.g. polygon to bitmap) and all corresponding objects"

docker_image

Docker image used to launch the app with all pre-installed requirements

"docker_image": "supervisely/base-py-sdk:6.4.57"

instance_version

Minimum instance version to launch app. Same as min_instance_version. Current instance version can be found at the bottom right corner of the Supervisely page.

"instance_version": "6.4.57"

main_script

Relative path to the main script of the application from the root of the project

"main_script": "src/convert_class_shape.py"

gui_template

Relative path to the GUI template from the root of the project

"gui_template": "src/gui.html"

modal_template

Relative path to the modal window template from the root of the project. GUI apps can use modal window functionality too. In case of this app modal window only contain text information hence modal_template_state is not needed

"modal_template": "src/modal.html"

task_location

Specifies where to display task

workspace task

"task_location": "workspace_tasks"

isolate

Runs app in isolated container

"isolate": true

icon

Link to the app icon

"icon": "https://i.imgur.com/TxR0dfX.png"

icon_background

Background of app icon in hex color code

"icon_background": "#FFFFFF"

context_menu

App context menu configuration

"context_menu": {
    "target": ["images_project"],
    "context_category": "Transform"
  }

poster

Link to app poster

"poster": "https://github.com/supervisely-ecosystem/import-images/releases/download/v1.0.0/poster.png"