From script to Supervisely App

Introduction
The main point: ✅ any python script can be easily transformed into Supervisely App ✅. And in this tutorial, you will learn how to do it.  It will show you how to add the necessary files and structure to create the app from a python script, and how to add it to the Supervisely platform.
We will write a simple Python program that prints user login to console (stdout) in ASCII art (also known as "computer text art").
We will go through the following steps:
​Step 1. Prepare a tiny python script.
​Step 2. How to transform this script into Supervisely App
​Step 3. How to add custom private app into Supervisley Platform.
​Step 4. How to run it in Supervisely.
Everything you need to reproduce this tutorial is on GitHub: source code and additional app files.
Step 1. Python script
The python program that takes user login from ENV variable and prints it to console (STDOUT) as ASCII art using ART python package  ​
​.
import os
from dotenv import load_dotenv
from art import tprint
​
# load ENV variables for debug
# has no effect in production
load_dotenv("local.env")
​
​
def main():
    name = os.environ["context.userLogin"]
    print("Hello World! This app is run by the user:")
    tprint(name)
​
​
if __name__ == "__main__":
    main()
Here is an example of the output of this tiny python program:
Hello World! This app is run by the user:
                        
 _ __ ___    __ _ __  __
| '_ ` _ \  / _` |\ \/ /
| | | | | || (_| | >  < 
|_| |_| |_| \__,_|/_/\_\
                        
Step 2. From script to Supervisely App
Repository structure
Supervisely App is just a git repository on Github or Gitlab. For this particular app the files structure  should be the following:
.
├── README.md
├── config.json
├── requirements.txt
└── src
    └── main.py
Let's explain every file:
README.md [optional] - contains an explanation of what this app does and how to use it. You can provide here all information that can be useful for the end-user (screenshots, gifs, videos, demos, examples).
requirements.txt  [optional] - here you can specify all Python modules (pip packages) that are needed for your python program. This is a common convention in Python development. In our example we use two packages: art ​
​to do cool prints to console and black 
 for automatic code formatting.
# used to print cool text to stdout
art==5.7 
​
# my favorite code formatter
black==22.6.0 
config.json - This file will contain all your app metadata information, like name, description, poster URL, icon URL, app tags for Ecosystem, docker image, and so on. This file will be explained in detail in the next guides.
src/main.py our python program. 
The two files below are in the repo but they are used ONLY for debug purposes and are provided for your convenience.
.
├── create_venv.sh
└── local.env
App configuration
App configuration is stored in config.json file. A detailed explanation of all possible fields in app configuration will be covered in other tutorials. Let's check the config for our small app:  
{
  "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"
}
Let's go through the fields:
main_script - relative path to the main script (entry point) in a git repository
"headless": true means that app has no User Interface
name, description and poster define how the app will look in the Supervisely Ecosystem
poster, name, descripotion
icon, categories - categories help to navigate in the Supervisely Ecosystem and it is a user-friendly way to explore apps
icon and categories
Step 3. How to add your private app
Supervisely supports both private and public apps. 
🔒 Private apps are those that are available only on private Supervisely Instances (Enterprise Edition).
🌎 Public apps are available on all private Supervisely Instances and in Community Edition. The guidelines for adding public apps will be covered in other tutorials. 
Since Supervisely app is just a git repository, we support public and private repos from the most popular hosting platforms in the world - GitHub and GitLab. You just need to generate and provide  access token to your repo. Learn more in the documentation.
Go to Ecosystem -> Private Apps -> Add private app. 
Add private app
Step 4. Run your app in Supervisely
There are multiple ways how application can be integrated into Supervisely Platform. App can be run from context menu of project / dataset / labeling job / user / and so on ... Or app can be run right from labeling interface. All possible running options will be covered in next tutorials. 
For simplicity, we will run our app from the Ecosystem page. 
Let's run our app
​
​
​

Getting Started - Previous

Spatial labels

Next - Advanced user guide

In-depth App development

Last modified 9d ago

Copy link

Edit on GitHub

Outline

Introduction

Step 1. Python script

Step 2. From script to Supervisely App

Repository structure

App configuration

Step 3. How to add your private app

Step 4. Run your app in Supervisely