Adding Application Metadata

Introduction

Adding application metadata such as the name, description, and version of your application is a simple process. Rescue-Box Desktop uses this metadata to display information about your application in the application list.

It is very simple to add metadata to your Flask-ML application. In your server.py file:

from flask_ml.flask_ml import MLServer, load_file_as_string

server = MLServer(__name__)

server.add_app_metadata(
    name="Transform Case",
    author="Flask-ML Team",
    version="0.1.0",
    info=load_file_as_string("simple_server_info.md"),
)

Here, info is a Markdown string that contains an overview of your application. See Sample Application Info for an example.

This creates a new route at /api/app_metadata that returns the metadata as a JSON object. This will be used by Rescue-Box Desktop to display it here:

Introduction​

Introduction