Skip to content

adalib.apps

The Apps sub-package exposes the core integrations of the deployed apps in AdaLab.

Functions

delete_app 

delete_app(app_id)

Delete a deployed app from AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required
Source code in adalib/apps/apps.py 
 9
10
11
12
13
14
15
16
17
18
19
20
def delete_app(app_id: str) -> None:
    """
    Delete a deployed app from AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/delete_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    """

    adaboard.request_adaboard(path=f"apps/{app_id}/", method=requests.delete)
    return None

deploy_app 

deploy_app(name, description, metadata_id, url_path_prefix, stripped_prefix=True, port=80, replicas=1, environment_variables={}, max_cpu=1.0, min_cpu=0.0, max_ram=500, min_ram=20, command='', acl_type='public', acl_userlist=[], acl_group_names=[], idp_enabled=False, idp_scope='')

Deploy an app to AdaLab from an existing metadata object.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
name str

the app's name

 required
description str

the app's description

 required
metadata_id int

the ID of the metadata object

 required
url_path_prefix str

URL endpoint to deploy the app to

 required
stripped_prefix bool

whether to strip the apps/{app_url} prefix from the URL, defaults to True

 True
port int

the port where the app is served from, defaults to 80

 80
replicas int

number of replicas to deploy, defaults to 1

 1
environment_variables dict

environment variables to pass to the app, defaults to {}

 {}
max_cpu float

maximum CPU usage allowed (vCPU), defaults to 1.0

 1.0
min_cpu float

minimum CPU usage allowed (vCPU), defaults to 0.0

 0.0
max_ram int

maximum RAM usage allowed (Mb), defaults to 500

 500
min_ram int

minimum RAM usage allowed (Mb), defaults to 20

 20
command str

command to start up the app, defaults to ""

 ''
acl_type str

type of access control list, defaults to "public"

 'public'
acl_userlist list[str]

list of users allowed to access the app when acl_type="userlist", defaults to []

 []
acl_group_names list[str]

list of groups allowed to access the app when acl_type="group", defaults to []

 []
idp_enabled bool

whether to enable IdP token in app headers, defaults to False

 False
idp_scope str

IdP token scope, defaults to ""

 ''

Returns:

Type Description
str

the app's ID
Source code in adalib/apps/apps.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def deploy_app(
    name: str,
    description: str,
    metadata_id: int,
    url_path_prefix: str,
    stripped_prefix: bool = True,
    port: int = 80,
    replicas: int = 1,
    environment_variables: dict = {},
    max_cpu: float = 1.0,
    min_cpu: float = 0.0,
    max_ram: int = 500,
    min_ram: int = 20,
    command: str = "",
    acl_type: str = "public",
    acl_userlist: list[str] = [],
    acl_group_names: list[str] = [],
    idp_enabled: bool = False,
    idp_scope: str = "",
) -> str:
    """
    Deploy an app to AdaLab from an existing metadata object.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/deploy_app.ipynb) to test this function or build upon it.

    :param name: the app's name
    :type name: str
    :param description: the app's description
    :type description: str
    :param metadata_id: the ID of the metadata object
    :type metadata_id: int
    :param url_path_prefix: URL endpoint to deploy the app to
    :type url_path_prefix: str
    :param stripped_prefix: whether to strip the apps/{app_url} prefix from the URL, defaults to True
    :type stripped_prefix: bool, optional
    :param port: the port where the app is served from, defaults to 80
    :type port: int, optional
    :param replicas: number of replicas to deploy, defaults to 1
    :type replicas: int, optional
    :param environment_variables: environment variables to pass to the app, defaults to {}
    :type environment_variables: dict, optional
    :param max_cpu: maximum CPU usage allowed (vCPU), defaults to 1.0
    :type max_cpu: float, optional
    :param min_cpu: minimum CPU usage allowed (vCPU), defaults to 0.0
    :type min_cpu: float, optional
    :param max_ram: maximum RAM usage allowed (Mb), defaults to 500
    :type max_ram: int, optional
    :param min_ram: minimum RAM usage allowed (Mb), defaults to 20
    :type min_ram: int, optional
    :param command: command to start up the app, defaults to ""
    :type command: str, optional
    :param acl_type: type of access control list, defaults to "public"
    :type acl_type: str, optional
    :param acl_userlist: list of users allowed to access the app when acl_type="userlist", defaults to []
    :type acl_userlist: list, optional
    :param acl_group_names: list of groups allowed to access the app when acl_type="group", defaults to []
    :type acl_group_names: list, optional
    :param idp_enabled: whether to enable IdP token in app headers, defaults to False
    :type idp_enabled: bool, optional
    :param idp_scope: IdP token scope, defaults to ""
    :type idp_scope: str, optional
    :return: the app's ID
    :rtype: str
    """

    # Build the payload for the request
    payload = {
        "name": name,
        "description": description,
        "metadata_id": metadata_id,
        "url_path_prefix": url_path_prefix,
        "stripped_prefix": stripped_prefix,
        "port": port,
        "replicas": replicas,
        "environment_variables": environment_variables,
        "max_cpu": max_cpu,
        "min_cpu": min_cpu,
        "max_ram": max_ram,
        "min_ram": min_ram,
        "command": command,
        "acl_type": acl_type,
        "acl_userlist": acl_userlist,
        "acl_group_names": acl_group_names,
        "idp_enabled": idp_enabled,
        "idp_scope": idp_scope,
    }

    # Check that the app configuration is valid and update payload
    validate_acl("app", False, acl_type)
    if acl_type == "public":
        payload.pop("acl_userlist")
        payload.pop("acl_group_names")
    elif acl_type == "userlist":
        assert (
            isinstance(acl_userlist, list) and len(acl_userlist) > 0
        ), "ACL type is userlist but no users were specified."
        payload.pop("acl_group_names")
    elif acl_type == "group":
        assert (
            isinstance(acl_group_names, list) and len(acl_group_names) > 0
        ), "ACL type is group but no groups were specified."
        payload.pop("acl_userlist")

    # Deploy the app
    response = adaboard.request_adaboard(
        path="apps/", method=requests.post, json=payload
    ).json()

    # Return the ID of the deployed app
    return response["id"]

edit_app 

edit_app(app_id, name=None, description=None, metadata_id=None, url_path_prefix=None, stripped_prefix=None, port=None, replicas=None, environment_variables=None, max_cpu=None, min_cpu=None, max_ram=None, min_ram=None, command=None, acl_type=None, acl_userlist=None, acl_group_names=None, idp_enabled=None, idp_scope=None)

Edit a deployed app's configuration.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required
name str

the app's name, defaults to None (old one)

 None
description str

the app's description, defaults to None (old one)

 None
metadata_id int

the ID of the metadata object, defaults to None (old one)

 None
url_path_prefix str

URL endpoint to deploy the app to, defaults to None (old one)

 None
stripped_prefix bool

whether to strip the apps/{app_url} prefix from the URL, defaults to None (old one)

 None
port int

the port where the app is served from, defaults to None (old one)

 None
replicas int

number of replicas to deploy, defaults to None (old one)

 None
environment_variables dict

environment variables to pass to the app, defaults to None (old one)

 None
max_cpu float

maximum CPU usage allowed (vCPU), defaults to None (old one)

 None
min_cpu float

minimum CPU usage allowed (vCPU), defaults to None (old one)

 None
max_ram int

maximum RAM usage allowed (Mb), defaults to None (old one)

 None
min_ram int

minimum RAM usage allowed (Mb), defaults to None (old one)

 None
command str

command to start up the app, defaults to None (old one)

 None
acl_type str

type of access control list, defaults to None (old one)

 None
acl_userlist list[str]

list of users allowed to access the app when acl_type="userlist", defaults to None (old one)

 None
acl_group_names list[str]

list of groups allowed to access the app when acl_type="group", defaults to None (old one)

 None
idp_enabled bool

whether to enable IdP token in app headers, defaults to None (old one)

 None
idp_scope str

IdP token scope, defaults to None (old one)

 None

Returns:

Type Description
None

nothing
Source code in adalib/apps/apps.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def edit_app(
    app_id: str,
    name: str = None,
    description: str = None,
    metadata_id: int = None,
    url_path_prefix: str = None,
    stripped_prefix: bool = None,
    port: int = None,
    replicas: int = None,
    environment_variables: dict = None,
    max_cpu: float = None,
    min_cpu: float = None,
    max_ram: int = None,
    min_ram: int = None,
    command: str = None,
    acl_type: str = None,
    acl_userlist: list[str] = None,
    acl_group_names: list[str] = None,
    idp_enabled: bool = None,
    idp_scope: str = None,
) -> None:
    """
    Edit a deployed app's configuration.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/edit_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :param name: the app's name, defaults to None (old one)
    :type name: str, optional
    :param description: the app's description, defaults to None (old one)
    :type description: str, optional
    :param metadata_id: the ID of the metadata object, defaults to None (old one)
    :type metadata_id: int, optional
    :param url_path_prefix: URL endpoint to deploy the app to, defaults to None (old one)
    :type url_path_prefix: str, optional
    :param stripped_prefix: whether to strip the apps/{app_url} prefix from the URL, defaults to None (old one)
    :type stripped_prefix: bool, optional
    :param port: the port where the app is served from, defaults to None (old one)
    :type port: int, optional
    :param replicas: number of replicas to deploy, defaults to None (old one)
    :type replicas: int, optional
    :param environment_variables: environment variables to pass to the app, defaults to None (old one)
    :type environment_variables: dict, optional
    :param max_cpu: maximum CPU usage allowed (vCPU), defaults to None (old one)
    :type max_cpu: float, optional
    :param min_cpu: minimum CPU usage allowed (vCPU), defaults to None (old one)
    :type min_cpu: float, optional
    :param max_ram: maximum RAM usage allowed (Mb), defaults to None (old one)
    :type max_ram: int, optional
    :param min_ram: minimum RAM usage allowed (Mb), defaults to None (old one)
    :type min_ram: int, optional
    :param command: command to start up the app, defaults to None (old one)
    :type command: str, optional
    :param acl_type: type of access control list, defaults to None (old one)
    :type acl_type: str, optional
    :param acl_userlist: list of users allowed to access the app when acl_type="userlist", defaults to None (old one)
    :type acl_userlist: list, optional
    :param acl_group_names: list of groups allowed to access the app when acl_type="group", defaults to None (old one)
    :type acl_group_names: list, optional
    :param idp_enabled: whether to enable IdP token in app headers, defaults to None (old one)
    :type idp_enabled: bool, optional
    :param idp_scope: IdP token scope, defaults to None (old one)
    :type idp_scope: str, optional
    :return: nothing
    :rtype: None
    """

    # Collect configuration options
    app_config = {
        "name": name,
        "description": description,
        "metadata_id": metadata_id,
        "url_path_prefix": url_path_prefix,
        "stripped_prefix": stripped_prefix,
        "port": port,
        "replicas": replicas,
        "environment_variables": environment_variables,
        "max_cpu": max_cpu,
        "min_cpu": min_cpu,
        "max_ram": max_ram,
        "min_ram": min_ram,
        "command": command,
        "acl_type": acl_type,
        "acl_userlist": acl_userlist,
        "acl_group_names": acl_group_names,
        "idp_enabled": idp_enabled,
        "idp_scope": idp_scope,
    }

    # Check that the app configuration is valid and update payload
    if acl_type:
        validate_acl("app", True, acl_type)
        if acl_type == "public":
            app_config.pop("acl_userlist")
            app_config.pop("acl_group_names")
        elif acl_type == "userlist":
            assert (
                isinstance(acl_userlist, list) and len(acl_userlist) > 0
            ), "ACL type is userlist but no users were specified."
            app_config.pop("acl_group_names")
        elif acl_type == "group":
            assert (
                isinstance(acl_group_names, list) and len(acl_group_names) > 0
            ), "ACL type is group but no groups were specified."
            app_config.pop("acl_userlist")

    # Fetch old configuration
    old_config = adaboard.request_adaboard(
        path=f"apps/{app_id}/", method=requests.get
    ).json()

    # Build request payload combining new and old options
    payload = {
        k: v if v is not None else old_config[k] for k, v in app_config.items()
    }

    adaboard.request_adaboard(
        path=f"apps/{app_id}/", method=requests.put, json=payload
    )

    return None

get_all_apps 

get_all_apps()

Get information for all the apps deployed in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Returns:

Type Description
list

list with all the information of each app
Source code in adalib/apps/apps.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
def get_all_apps() -> (
    list[dict[str, str | int | bool | dict[str, str] | list[str]]]
):
    """
    Get information for all the apps deployed in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_all_apps.ipynb) to test this function or build upon it.

    :return: list with all the information of each app
    :rtype: list
    """

    # If the user is privileged enough, get all apps
    response_roles = adaboard.request_adaboard(path="users/self").json()
    include_all = any(
        role in PRIVILEGED_ROLES
        for role in response_roles["roles"]["adaboard"]
    )
    # Get the list of all apps
    response = adaboard.request_adaboard(
        path=f"apps/?all={include_all}", method=requests.get
    ).json()

    return response

get_app 

get_app(app_id)

Get the information of a specific deployed app in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required

Returns:

Type Description
dict

app's information
Source code in adalib/apps/apps.py 
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
def get_app(
    app_id: str,
) -> dict[str, str | int | bool | dict[str, str] | list[str]]:
    """
    Get the information of a specific deployed app in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :return: app's information
    :rtype: dict
    """

    response = adaboard.request_adaboard(
        path=f"apps/{app_id}/", method=requests.get
    ).json()

    return response

get_app_id 

get_app_id(app_name='', author_id='', app_url='')

Get the ID of a deployed app in AdaLab. Either app_url, or app_name and author_id, must be specified.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_name str

name of the app, defaults to ""

 ''
author_id str

author of the app, defaults to ""

 ''
app_url str

endpoint of the app's URL, defaults to ""

 ''

Returns:

Type Description
str

the app's ID
Source code in adalib/apps/apps.py 
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
def get_app_id(
    app_name: str = "", author_id: str = "", app_url: str = ""
) -> str:
    """
    Get the ID of a deployed app in AdaLab. Either app_url, or app_name and author_id, must be specified.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_app_id.ipynb) to test this function or build upon it.

    :param app_name: name of the app, defaults to ""
    :type app_name: str, optional
    :param author_id: author of the app, defaults to ""
    :type author_id: str, optional
    :param app_url: endpoint of the app's URL, defaults to ""
    :type app_url: str, optional
    :return: the app's ID
    :rtype: str
    """

    # Check that enough information is provided to find the app
    assert (
        app_name and author_id
    ) or app_url, (
        "Either app_url, or app_name and author_id, must be specified."
    )
    # If the user is privileged enough, get all apps
    response_roles = adaboard.request_adaboard(path="users/self").json()
    include_all = any(
        role in PRIVILEGED_ROLES
        for role in response_roles["roles"]["adaboard"]
    )
    # Get the list of all apps
    response = adaboard.request_adaboard(
        path=f"apps/?all={include_all}", method=requests.get
    ).json()

    # Return the ID of the requested app
    try:
        if app_url:
            return [
                app["app_id"]
                for app in response
                if app["url_path_prefix"] == app_url
            ][0]
        else:
            return [
                app["app_id"]
                for app in response
                if app["name"] == app_name and app["user_id"] == author_id
            ][0]
    except IndexError:
        raise ValueError("No app found with the specified parameters.")

get_app_logs 

get_app_logs(app_id, system=False)

Get the execution or deployment logs of a deployed app in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required
system bool

whether to get the system logs or the deployment logs, defaults to False

 False

Returns:

Type Description
str

deployment logs
Source code in adalib/apps/apps.py 
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def get_app_logs(
    app_id: str, system: bool = False
) -> str | list[dict[str, str]]:
    """
    Get the execution or deployment logs of a deployed app in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_app_logs.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :param system: whether to get the system logs or the deployment logs, defaults to False
    :type system: bool, optional
    :return: deployment logs
    :rtype: str
    """

    response = adaboard.request_adaboard(
        path=f"apps/{app_id}/logs/?system={system}", method=requests.get
    ).json()

    if system:
        return response
    else:
        return response["log"]

get_apps_by_author 

get_apps_by_author(author_id)

Get information for all the apps deployed in AdaLab by a specific author.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
author_id str

the ID of the app's author

 required

Returns:

Type Description
list

list with all the information of each app
Source code in adalib/apps/apps.py 
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
def get_apps_by_author(
    author_id: str,
) -> list[dict[str, str | int | bool | dict[str, str] | list[str]]]:
    """
    Get information for all the apps deployed in AdaLab by a specific author.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_apps_by_author.ipynb) to test this function or build upon it.

    :param author_id: the ID of the app's author
    :type author_id: str
    :return: list with all the information of each app
    :rtype: list
    """

    # If the user is privileged enough, get all apps
    response_roles = adaboard.request_adaboard(path="users/self").json()
    include_all = any(
        role in PRIVILEGED_ROLES
        for role in response_roles["roles"]["adaboard"]
    )
    # Get the list of all apps
    response = adaboard.request_adaboard(
        path=f"apps/?all={include_all}", method=requests.get
    ).json()

    return [app for app in response if app["user_id"] == author_id]

get_apps_status 

get_apps_status()

Get the status of all the apps deployed in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Returns:

Type Description
dict

dictionary with the status of each app
Source code in adalib/apps/apps.py 
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
def get_apps_status() -> dict[str, str]:
    """
    Get the status of all the apps deployed in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/get_apps_status.ipynb) to test this function or build upon it.

    :return: dictionary with the status of each app
    :rtype: dict
    """

    # Get status report for all apps
    response_stats = adaboard.request_adaboard(
        path="apps/status/", method=requests.get
    ).json()

    # If the user is privileged enough, get all apps
    response_roles = adaboard.request_adaboard(path="users/self").json()
    include_all = any(
        role in PRIVILEGED_ROLES
        for role in response_roles["roles"]["adaboard"]
    )
    # Get the list of all apps
    response_apps = adaboard.request_adaboard(
        path=f"apps/?all={include_all}", method=requests.get
    ).json()

    # Build dictionary with the status of each app
    apps_status = [
        {
            "name": app["name"],
            "author": app["user_id"],
            "URL": app["url_path_prefix"],
            "status": response_stats[str(app["status"])],
        }
        for app in response_apps
    ]
    return apps_status

restart_app 

restart_app(app_id)

Restart a deployed app in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required

Returns:

Type Description
None

nothing
Source code in adalib/apps/apps.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
def restart_app(app_id: str) -> None:
    """
    Restart a deployed app in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/restart_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :return: nothing
    :rtype: None
    """

    adaboard.request_adaboard(
        path=f"apps/{app_id}/restart/", method=requests.put
    )
    return None

start_app 

start_app(app_id)

Start a deployed app in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required

Returns:

Type Description
None

nothing
Source code in adalib/apps/apps.py 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
def start_app(app_id: str) -> None:
    """
    Start a deployed app in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/start_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :return: nothing
    :rtype: None
    """

    adaboard.request_adaboard(
        path=f"apps/{app_id}/start/", method=requests.put
    )

    return None

stop_app 

stop_app(app_id)

Stop a deployed app in AdaLab.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
app_id str

the app's ID

 required

Returns:

Type Description
None

nothing
Source code in adalib/apps/apps.py 
489
490
491
492
493
494
495
496
497
498
499
500
501
502
def stop_app(app_id: str) -> None:
    """
    Stop a deployed app in AdaLab.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/apps/stop_app.ipynb) to test this function or build upon it.

    :param app_id: the app's ID
    :type app_id: str
    :return: nothing
    :rtype: None
    """

    adaboard.request_adaboard(path=f"apps/{app_id}/stop/", method=requests.put)
    return None