about

"""
This python snippet is to be used with Trend AV (V. 127)

Note: Be sure to save this file as 'about.py' in the current working directory
"""

def display_about_text():
    print(
            f"\n\n\nABOUT TREND AV - GOOGLE TRENDS DATA ANALYSIS AND VISUALIZER TOOL"
            f"\nOVERVIEW\nVERSION: 1.27\nAUTHOR: JEOI REQI\nDATE: FEBRUARY 2024"
            f"\n\nDESCRIPTION:"
            f"\nTREND AV IS A PYTHON SCRIPT THAT UTILIZES THE GOOGLE TRENDS API TO ANALYZE AND VISUALIZE"
            f"\nTHE INTEREST OVER TIME FOR USER-SPECIFIED TOPICS. IT GENERATES MONTHLY SEPARATED LINE"
            f"\nPLOTS WITH EMPTY BULLETS, 3D BAR PLOTS, PIE CHARTS & SCATTER PLOTS WITH AVERAGE VALUES,"
            f"\nGENERATES WORDCLOUDS, ANIMATES PLOTS, DISPLAYS RELATED TOPICS, AND SAVES THE OUTPUT TO A TEXT FILE."
            f"\n\nKEY FEATURES:"
            f"\n1. [INTEREST OVER TIME ANALYSIS]"
            f"\n   VISUALIZE THE INTEREST OVER TIME FOR A SET OF TOPICS. MONTHLY LINE PLOTS WITH"
            f"\n   DISTINCTIVE HOLLOW BULLETS PROVIDE AN INTUITIVE REPRESENTATION OF THE TRENDS"
            f"\n   FOR EACH SPECIFIED KEYWORD."
            f"\n2. [3D BAR PLOTS]"
            f"\n   GO BEYOND CONVENTIONAL PLOTTING METHODS WITH 3D BAR PLOTS. THIS VISUALLY"
            f"\n   STRIKING REPRESENTATION ALLOWS YOU TO EXPLORE THE NUANCES OF INTEREST LEVELS"
            f"\n   ACROSS DIFFERENT TOPICS AND TIME PERIODS."
            f"\n3. [PIE CHARTS WITH AVERAGE VALUES]"
            f"\n   GENERATE PIE CHARTS WITH AVERAGE VALUES FOR A QUICK OVERVIEW OF THE COLLECTIVE"
            f"\n   STRENGTH OF SELECTED TOPICS. THIS FEATURE CONDENSES THE DATA INTO A"
            f"\n   COMPREHENSIVE VISUAL DISPLAY, MAKING IT EASIER TO IDENTIFY DOMINANT TRENDS."
            f"\n4. [SCATTER PLOT]"
            f"\n   EXPLORE THE DISTRIBUTION OF INTEREST LEVELS OVER TIME WITH A SCATTER PLOT WITH AVERAGES."
            f"\n   THIS OPTION GENERATES A VISUAL REPRESENTATION OF THE DATA POINTS FOR EACH SPECIFIED KEYWORD, ALLOWING"
            f"\n   YOU TO IDENTIFY PATTERNS AND TRENDS. THE SCATTER PLOT IS PARTICULARLY USEFUL WHEN"
            f"\n   EXAMINING RELATIONSHIPS BETWEEN MULTIPLE TOPICS."
            f"\n5. [STACK PLOT]"
            f"\n   GENERATE AND DISPLAY A STACK PLOT. THIS PLOT PROVIDES A VISUAL REPRESENTATION OF THE CUMULATIVE"
            f"\n   INTEREST LEVELS OF MULTIPLE TOPICS OVER TIME. IT IS USEFUL FOR COMPARING THE OVERALL IMPACT"
            f"\n   OF DIFFERENT KEYWORDS ON THE TREND."
            f"\n6. [WORDCLOUD]"
            f"\n   INCLUDED IN THE 'VIEW ALL PLOTS' OPTION, YOU CAN GENERATE A WORDCLOUD BASED"
            f"\n   ON RELATED QUERIES TO VISUALLY REPRESENT THE MOST RELEVANT TERMS."
            f"\n7. [RELATED TOPICS EXPLORATION]"
            f"\n   EXPLORE RELATED TOPICS BY DISPLAYING BOTH TOP AND RISING QUERIES ASSOCIATED"
            f"\n   WITH YOUR SPECIFIED KEYWORDS. THE RELATED DATA IS PRESENTED IN A TABULAR"
            f"\n   FORMAT, OFFERING A DETAILED OVERVIEW."
            f"\n8. [ANIMATE PLOT]"
            f"\n   ENABLE THIS OPTION TO ADD DYNAMIC ANIMATION TO THE PLOTS. WHEN SELECTED, THE PLOT WILL"
            f"\n   DISPLAY A TIME-BASED ANIMATION, PROVIDING A VISUAL REPRESENTATION OF HOW INTEREST"
            f"\n   LEVELS EVOLVE OVER THE SELECTED TIMEFRAME. THIS FEATURE ADDS A DYNAMIC ELEMENT TO"
            f"\n   THE VISUALIZATION, MAKING IT EASIER TO OBSERVE TRENDS AND CHANGES IN INTEREST OVER TIME."
            f"\n9. [DATA EXPORT]"
            f"\n   SAVE THE DISPLAYED DATA, INCLUDING RELATED QUERIES AND TERMINAL OUTPUT, TO"
            f"\n   A DYNAMICALLY NAMED TEXT FILE FOR FUTURE REFERENCE AND ANALYSIS."
            f"\n\nHOW TO USE"
            f"\n1. [SETUP]"
            f"\n   ENSURE YOU HAVE THE REQUIRED PYTHON LIBRARIES INSTALLED, INCLUDING"
            f"\n   MATPLOTLIB, PYTRENDS, WARNINGS, TABULATE, AND NUMPY. RUN THE SCRIPT IN A PYTHON"
            f"\n   ENVIRONMENT."
            f"\n2. [INPUT TOPICS]"
            f"\n   ENTER THE NUMBER OF TOPICS YOU WANT TO ANALYZE (UP TO A MAXIMUM OF 5). PROVIDE"
            f"\n   THE SPECIFIC TOPICS OR QUERIES OF INTEREST."
            f"\n3. [SELECT TIMEFRAME]"
            f"\n   SPECIFY THE NUMBER OF MONTHS FOR WHICH YOU WANT TO ANALYZE THE DATA (UP TO A"
            f"\n   MAXIMUM OF 12)."
            f"\n4. [EXPLORE MENU OPTIONS]"
            f"\n   CHOOSE FROM A RANGE OF MENU OPTIONS, INCLUDING LINE PLOTS, 3D BAR PLOTS, PIE"
            f"\n   CHARTS, AND RELATED DATA EXPLORATION. VIEW ALL PLOTS SIMULTANEOUSLY FOR A"
            f"\n   HOLISTIC UNDERSTANDING OF THE TRENDS."
            f"\n5. [SAVE DATA]"
            f"\n   OPTIONALLY SAVE THE DISPLAYED DATA TO A TEXT FILE FOR FUTURE ANALYSIS."
            f"\n6. [RESET PROGRAM]"
            f"\n   THIS OPTION RESETS THE PROGRAM, PROVIDING THE USER WITH A FRESH START."
            f"\n   CHOOSING THIS OPTION ALLOWS YOU TO INPUT NEW TOPICS AND RESTART THE ANALYSIS."
            f"\n\nNOTE:"
            f"\nENSURE A STABLE INTERNET CONNECTION FOR FETCHING DATA FROM THE GOOGLE TRENDS API."
            f"\n\nTREND AV EMPOWERS USERS TO DERIVE VALUABLE INSIGHTS FROM GOOGLE TRENDS DATA"
            f"\nEFFORTLESSLY. WHETHER YOU'RE A DATA ENTHUSIAST, MARKETER, OR RESEARCHER, THIS SCRIPT"
            f"\nPROVIDES A ROBUST PLATFORM FOR EXPLORING AND UNDERSTANDING TRENDS ACROSS VARIOUS"
            f"\nTOPICS.\n\n\n"
            )