UTI: Add comments and clean the code.
[csit.git] / resources / tools / dash / app / pal / __init__.py
1 # Copyright (c) 2022 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 """Initialize Flask app.
15 """
16
17 import logging
18
19 from flask import Flask
20 from flask_assets import Environment
21
22
23 # Maximal value of TIME_PERIOD for Trending in days.
24 # Do not change without a good reason.
25 MAX_TIME_PERIOD = 180
26
27 # It defines the time period for Trending in days from now back to the past from
28 # which data is read to dataframes.
29 # TIME_PERIOD = None means all data (max MAX_TIME_PERIOD days) is read.
30 # TIME_PERIOD = MAX_TIME_PERIOD is the default value
31 TIME_PERIOD = MAX_TIME_PERIOD  # [days]
32
33 # List of releases used for iterative data processing.
34 # The releases MUST be in the order from the current (newest) to the last
35 # (oldest).
36 RELEASES=["csit2206", "csit2202", ]
37
38 def init_app():
39     """Construct core Flask application with embedded Dash app.
40     """
41
42     logging.basicConfig(
43         format=u"%(asctime)s: %(levelname)s: %(message)s",
44         datefmt=u"%Y/%m/%d %H:%M:%S",
45         level=logging.INFO
46     )
47
48     logging.info("Application started.")
49
50     app = Flask(__name__, instance_relative_config=False)
51     app.config.from_object(u"config.Config")
52
53     with app.app_context():
54         # Import parts of our core Flask app.
55         from . import routes
56
57         assets = Environment()
58         assets.init_app(app)
59
60         # Set the time period for Trending
61         if TIME_PERIOD is None or TIME_PERIOD > MAX_TIME_PERIOD:
62             time_period = MAX_TIME_PERIOD
63         else:
64             time_period = TIME_PERIOD
65
66         # Import Dash applications.
67         from .news.news import init_news
68         app = init_news(app)
69
70         from .stats.stats import init_stats
71         app = init_stats(app, time_period=time_period)
72
73         from .trending.trending import init_trending
74         app = init_trending(app, time_period=time_period)
75
76         from .report.report import init_report
77         app = init_report(app, releases=RELEASES)
78
79     return app
80
81
82 app = init_app()