csit.infra.dash/app/cdash/comparisons/comparisons.py

   1 # Copyright (c) 2024 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Instantiate the Report Dash application.
  15 """
  16
  17 import dash
  18 import pandas as pd
  19
  20 from ..utils.constants import Constants as C
  21 from .layout import Layout
  22
  23
  24 def init_comparisons(
  25         server,
  26         data_iterative: pd.DataFrame
  27     ) -> dash.Dash:
  28     """Create a Plotly Dash dashboard.
  29
  30     :param server: Flask server.
  31     :type server: Flask
  32     :returns: Dash app server.
  33     :rtype: Dash
  34     """
  35
  36     dash_app = dash.Dash(
  37         server=server,
  38         routes_pathname_prefix=C.COMP_ROUTES_PATHNAME_PREFIX,
  39         external_stylesheets=C.EXTERNAL_STYLESHEETS,
  40         title=C.COMP_TITLE
  41     )
  42
  43     layout = Layout(
  44         app=dash_app,
  45         data_iterative=data_iterative,
  46         html_layout_file=C.HTML_LAYOUT_FILE
  47     )
  48     dash_app.index_string = layout.html_layout
  49     dash_app.layout = layout.add_content()
  50
  51     return dash_app.server