csit.infra.dash/app/cdash/stats/stats.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 Statistics Dash application.
  15 """
  16 import dash
  17 import pandas as pd
  18
  19 from ..utils.constants import Constants as C
  20 from .layout import Layout
  21
  22
  23 def init_stats(
  24         server,
  25         data_stats: pd.DataFrame,
  26         data_trending: pd.DataFrame
  27     ) -> dash.Dash:
  28     """Create a Plotly Dash dashboard.
  29
  30     :param server: Flask server.
  31     :param data_stats: Pandas dataframe with staistical data.
  32     :param data_trending: Pandas dataframe with trending data.
  33     :type server: Flask
  34     :type data_stats: pandas.DataFrame
  35     :type data_trending: pandas.DataFrame
  36     :returns: Dash app server.
  37     :rtype: Dash
  38     """
  39
  40     dash_app = dash.Dash(
  41         server=server,
  42         routes_pathname_prefix=C.STATS_ROUTES_PATHNAME_PREFIX,
  43         external_stylesheets=C.EXTERNAL_STYLESHEETS,
  44         title=C.STATS_TITLE
  45     )
  46
  47     layout = Layout(
  48         app=dash_app,
  49         data_stats=data_stats,
  50         data_trending=data_trending,
  51         html_layout_file=C.HTML_LAYOUT_FILE,
  52         graph_layout_file=C.STATS_GRAPH_LAYOUT_FILE,
  53         tooltip_file=C.TOOLTIP_FILE
  54     )
  55     dash_app.index_string = layout.html_layout
  56     dash_app.layout = layout.add_content()
  57
  58     return dash_app.server