Apps

For a gentle introduction, see Technical Overview.
(TO DO) To explore an app, see Explore examples.
(TO DO)To know how to play with apps, see .

File structure

The default list of the files for an app is listed below :

Index	Filename	Description
1	__init__.py	File to indicate that the directory should be treated as a Python package.
2	[APP].json	The attributes of the app in JSON format. This is used by Snooz to understand how to handle this app.
3	[APP]View.py	This is where the actual work of the app takes place, including the definition of slots to interact with the UI. By default, only two methods are defined: `close_app` and `is_dirty`.
4	Ui_[APP]View.ui	.ui files are XML descriptions of a User Interface (UI). This file is used by Qt Designer, a WYSIWYG tool for creating UI in Qt. You won’t modify this file directly, only through Qt Designer. It’s the UI seen when the app is opened in Snooz.
5	Ui_[APP]View.py	The Python file generated (uic) from the .ui file of the same name which is edited through Qt Designer. You should not edit manually this file.

The details of the app are inside its JSON file (e.g. AppA.json)

{
    "item_name": "AppA",
    "item_type": "app",
    "item_api_version": "1.0.0",
    "dependencies": [
        {
            "package_name": "ExampleAppsPackage",
            "package_version": "0.0.0",
            "deleteable": false
        },
        {
            "package_name": "CEAMSModules",
            "package_version": "6.9.0"
        }
    ],
    "app_params":{
        "app_label":"App A",
        "app_category":"Examples",
        "custom_endpoints": ["AppA_endpoint"]
    }
}

The description of each needed attribute of the app :

Attribute	Description	Notes
item_name	The name of the app.	The name helps to identify the item, but we can find many instances of this item in the items list.
item_type	The type of items.	Valid values are: module, tool, process and app.
package_api_version	The version of the structure of this file.	The api version is linked to the Snooz architecture (for Snooz beta the api version is 1.0.0).
dependencies	A list of dictionnary that describes the package depedencies.	In the current example, its own package ExampleAppsPackage v0.0.0 and the CEAMSModules v6.9.0 are needed.