Update app.py

app.py

@@ -7,11 +7,9 @@ import os
 
 API_KEY = os.getenv("FMP_API_KEY")
 
-# Global constants (not exposed to the frontend)
 MAX_PAGES = 5
 DEFAULT_TOP_N = 10
 
-# Initialize session state variables if not already set
 if "historical_run" not in st.session_state:
     st.session_state.historical_run = False
 if "trending_run" not in st.session_state:
@@ -109,16 +107,16 @@ def plot_dual_axes(
 
 def run_historical_sentiment(ticker):
     st.write(
-        "This page displays historical social sentiment data for the ticker. "
-        "Five separate charts are generated: sentiment scores, posts, comments, likes, and impressions."
+        "This section shows how Stocktwits and Twitter sentiment changed over time."
     )
     df = get_historical_sentiment(ticker)
     if df.empty:
-        st.error("No data found for ticker " + ticker)
+        st.error("No data found for " + ticker)
         return
     common_range = [df["date"].min(), df["date"].max()]
-    
+
     st.subheader(f"{ticker} Sentiment Scores")
+    st.write("This plot compares the sentiment scores from Stocktwits and Twitter.")
     fig1 = plot_dual_axes(
         df, "date", "stocktwitsSentiment", "twitterSentiment",
         f"{ticker} Sentiment Scores",
@@ -128,6 +126,7 @@ def run_historical_sentiment(ticker):
     st.plotly_chart(fig1, use_container_width=True)
 
     st.subheader(f"{ticker} Posts")
+    st.write("This plot compares how many posts appear on each platform.")
     fig2 = plot_dual_axes(
         df, "date", "stocktwitsPosts", "twitterPosts",
         f"{ticker} Posts",
@@ -137,6 +136,7 @@ def run_historical_sentiment(ticker):
     st.plotly_chart(fig2, use_container_width=True)
 
     st.subheader(f"{ticker} Comments")
+    st.write("This plot compares the number of comments on Stocktwits and Twitter.")
     fig3 = plot_dual_axes(
         df, "date", "stocktwitsComments", "twitterComments",
         f"{ticker} Comments",
@@ -146,6 +146,7 @@ def run_historical_sentiment(ticker):
     st.plotly_chart(fig3, use_container_width=True)
 
     st.subheader(f"{ticker} Likes")
+    st.write("This plot compares how many likes each platform received.")
     fig4 = plot_dual_axes(
         df, "date", "stocktwitsLikes", "twitterLikes",
         f"{ticker} Likes",
@@ -155,6 +156,7 @@ def run_historical_sentiment(ticker):
     st.plotly_chart(fig4, use_container_width=True)
 
     st.subheader(f"{ticker} Impressions")
+    st.write("This plot compares the total impressions from Stocktwits and Twitter.")
     fig5 = plot_dual_axes(
         df, "date", "stocktwitsImpressions", "twitterImpressions",
         f"{ticker} Impressions",
@@ -249,13 +251,16 @@ def plot_trending(df, title, top_n):
 
 def run_trending_sentiment(top_n):
     st.write(
-        "This page shows trending sentiment data. Two grouped bar charts are created for bullish and bearish sentiments. "
-        "Each chart displays two bars per ticker: one for Sentiment and one for Last Sentiment."
+        "This section ranks stocks by bullish and bearish sentiment. "
+        "Two charts show the sentiment versus last known sentiment."
     )
     st.write("## Bullish Trending Sentiment")
+    st.write("The first chart shows the top bullish stocks and how sentiment changed from the last update.")
     bullish_df = fetch_trending_sentiment(sentiment_type="bullish", source="stocktwits")
     plot_trending(bullish_df, title="Bullish Trending Sentiment", top_n=top_n)
+
     st.write("## Bearish Trending Sentiment")
+    st.write("The second chart shows the top bearish stocks and how sentiment changed from the last update.")
     bearish_df = fetch_trending_sentiment(sentiment_type="bearish", source="stocktwits")
     plot_trending(bearish_df, title="Bearish Trending Sentiment", top_n=top_n)
 
@@ -345,13 +350,16 @@ def plot_change_sentiment(df, title, top_n):
 
 def run_change_sentiment(top_n):
     st.write(
-        "This page displays social sentiment change data. Two grouped bar charts are created for bullish and bearish sentiments. "
-        "Each chart shows two bars per ticker: one for Sentiment and one for Sentiment Change."
+        "This section shows how sentiment scores have changed. "
+        "We compare current sentiment to the change in sentiment."
     )
     st.write("## Bullish Sentiment Change")
+    st.write("This chart displays current bullish sentiment and how much it has changed recently.")
     bullish_df = fetch_change_sentiment(sentiment_type="bullish", source="stocktwits")
     plot_change_sentiment(bullish_df, title="Bullish Sentiment Change", top_n=top_n)
+
     st.write("## Bearish Sentiment Change")
+    st.write("This chart displays current bearish sentiment and how much it has changed recently.")
     bearish_df = fetch_change_sentiment(sentiment_type="bearish", source="stocktwits")
     plot_change_sentiment(bearish_df, title="Bearish Sentiment Change", top_n=top_n)
 
@@ -361,75 +369,77 @@ def run_change_sentiment(top_n):
 
 def main():
     st.set_page_config(page_title="Social Sentiment Analysis", layout="wide")
-    st.title("Social Sentiment Analysis Dashboard")
+    st.title("Trending Social Sentiment")
     st.write(
-        "This application provides three types of analysis on social sentiment data from FinancialModelingPrep. "
-        "Use the sidebar menu to select the type of analysis you want to run and adjust the options. "
-        "Click the 'Run' button to update the results."
+        "This tool offers three analyses of social sentiment. "
+        "They cover historical, trending, and changing sentiment from Stocktwits and Twitter. "
     )
-    
-    # Sidebar: Navigation and Options (inside an expander)
+
     with st.sidebar.expander("Navigation and Options", expanded=True):
         page = st.radio(
             "Select Analysis Page",
             ("Historical Sentiment", "Trending Sentiment", "Sentiment Change"),
-            help="Choose the analysis page you want to view."
+            help="Choose the type of sentiment analysis you want."
         )
-        
+
         if page == "Historical Sentiment":
             ticker = st.text_input(
                 "Ticker Symbol",
                 value=st.session_state.historical_ticker,
-                help="Enter the ticker symbol for which to display historical sentiment data."
+                help="Enter the ticker symbol for historical sentiment."
             )
             if st.button("Run Historical Sentiment Analysis"):
                 st.session_state.historical_run = True
                 st.session_state.historical_ticker = ticker
+
         elif page == "Trending Sentiment":
             top_n = st.number_input(
                 "Select Top N Stocks",
-                min_value=1, max_value=100,
+                min_value=1,
+                max_value=100,
                 value=st.session_state.trending_top_n,
-                help="Number of top stocks to display based on rank."
+                help="Pick how many stocks to show."
             )
             if st.button("Run Trending Sentiment Analysis"):
                 st.session_state.trending_run = True
                 st.session_state.trending_top_n = top_n
+
         elif page == "Sentiment Change":
             top_n = st.number_input(
                 "Select Top N Stocks",
-                min_value=1, max_value=100,
+                min_value=1,
+                max_value=100,
                 value=st.session_state.change_top_n,
-                help="Number of top stocks to display based on rank."
+                help="Pick how many stocks to show."
             )
             if st.button("Run Sentiment Change Analysis"):
                 st.session_state.change_run = True
                 st.session_state.change_top_n = top_n
 
-    # Main body: Display results based on the selected page and if run button was clicked
     if page == "Historical Sentiment":
         st.header("Historical Social Sentiment")
         if st.session_state.historical_run:
             run_historical_sentiment(st.session_state.historical_ticker)
         else:
-            st.info("Please select options in the sidebar and click 'Run Historical Sentiment Analysis'.")
+            st.info("Enter a ticker and run the analysis.")
+
     elif page == "Trending Sentiment":
         st.header("Trending Social Sentiment")
         if st.session_state.trending_run:
             run_trending_sentiment(st.session_state.trending_top_n)
         else:
-            st.info("Please select options in the sidebar and click 'Run Trending Sentiment Analysis'.")
+            st.info("Select a top N and run the analysis.")
+
     elif page == "Sentiment Change":
         st.header("Social Sentiment Change")
         if st.session_state.change_run:
             run_change_sentiment(st.session_state.change_top_n)
         else:
-            st.info("Please select options in the sidebar and click 'Run Sentiment Change Analysis'.")
+            st.info("Select a top N and run the analysis.")
 
 if __name__ == "__main__":
     main()
 
-
 hide_streamlit_style = """
 <style>
 #MainMenu {visibility: hidden;}
@@ -437,4 +447,3 @@ footer {visibility: hidden;}
 </style>
 """
 st.markdown(hide_streamlit_style, unsafe_allow_html=True)
-