Example 1. Headless

config.json for headless app explained

Introduction

We will take Hello World app as an example of a simple headless app that can be launched from Ecosystem, it uses minimum properties.

supervisely-ecosystem/hello-world-app/config.json

{
  "main_script": "src/main.py",
  "headless": true,
  "name": "Hello World!",
  "description": "Demonstrates how to turn your python script into Supervisely App",
  "categories": ["development"],
  "icon": "https://user-images.githubusercontent.com/12828725/182186256-5ee663ad-25c7-4a62-9af1-fbfdca715b57.png",
  "poster": "https://user-images.githubusercontent.com/12828725/182181033-d0d1a690-8388-472e-8862-e0cacbd4f082.png"
}

Headless app visual properties

Properties

main_script

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

"main_script": "src/main.py"

headless

Specifies that app does not have GUI

"headless": true

name

Name of the app in Supervisely

"name": "Hello World!"

description

Description of the app in Supervisely

"description": "Demonstrates how to turn your python script into Supervisely App"

categories

Сategories under which the app will be displayed in Ecosystem

"categories": ["development"]

icon

Link to the app icon

"icon": "https://user-images.githubusercontent.com/12828725/182186256-5ee663ad-25c7-4a62-9af1-fbfdca715b57.png"

poster

Link to the app poster

"poster": "https://user-images.githubusercontent.com/12828725/182181033-d0d1a690-8388-472e-8862-e0cacbd4f082.png"