7.2.2.3. Module axivion.dashboard.dashboard_server

Temporary local dashboard server utility.

Mainly useful for when an analysis database file is available and one wants to access its contents via the Python Dashboard API.

Classes

TemporaryDashboardServer(**kwargs)

Create and start a temporary local dashboard server.

TemporaryDashboardServer

class axivion.dashboard.dashboard_server.TemporaryDashboardServer(**kwargs)

Bases: object

Create and start a temporary local dashboard server.

Caution

configuration done on this dashboard server is not meant for being persistent and will be cleaned up in the end.

This is a closeable resource object. Preferably use the python resource idiom:

from axivion.dashboard.dashboard_server import TemporaryDashboardServer

with TemporaryDashboardServer() as server, server.create_admin_dashboard() as api:
    prj_name = api.install_project(db_file)
    ...

get_access_info()

Return url and admin credentials

Return type:

axivion.dashboard.setup_helper.AccessInfo

create_admin_dashboard()

Creates an object granting administrative access to this server.

Return type:

axivion.dashboard.Dashboard

Returns:

Dashboard initialized from get_access_info()

close()

Stop the server and delete its configuration files.