app.py

# -*- coding: utf-8 -*-
"""
WhatsApp Chat Analyser

This script uses Streamlit to create a web application for analyzing WhatsApp chat data.
It allows users to upload a text file containing a WhatsApp chat conversation and provides various analysis metrics and visualizations.

Author: Abhishek Santosh Gupta
GitHub: github.com/1abhi6
"""

import streamlit as st
from abc import ABC, abstractmethod

from preprocessor import Preprocess
from components import (
    Plot,
    SubHeader,
    PADDING_TOP
)

from analysis import (
    Analyse,
    UserList,
    GroupSpecificAnalysis
)


class Sidebar(ABC):
    """
    Abstract base class for the sidebar of the WhatsApp Chat Analyser web application.
    """

    def __init__(self):
        st.sidebar.title('WhatsApp Chat Analyser')
        self.sidebar()

    def sidebar(self):
        """
        Create the sidebar components and functionality.
        """
        upload_file = st.sidebar.file_uploader(
            'Choose a text file',
            help='Upload a .txt file of chat without media exported from WhatsApp.'
        )

        if upload_file is not None:
            bytes_data = upload_file.getvalue()
            data = bytes_data.decode('utf-8')

            try:
                preprocessor_obj = Preprocess(data)
                self.df = preprocessor_obj.text_to_df()
                self.user_list_obj = UserList(self.df)
                users_list = self.user_list_obj.user_list()

                self.selected_user = st.sidebar.selectbox(
                    'Show Analysis', users_list)
                self.analysis_obj = Analyse(self.df, self.selected_user)

                self.show_analysis_btn()

            except Exception as e:
                st.sidebar.error(e)

    @abstractmethod
    def show_analysis_btn(self):
        """
        Abstract method to be implemented by subclasses.
        Show the button to trigger the analysis.
        """
        pass


class Main(Sidebar):
    """
    Main class for the WhatsApp Chat Analyser web application.
    """

    def __init__(self):
        """
        Initialize the Main class and set the page configuration.
        """
        # Page configuration
        st.set_page_config(
            layout='wide', page_title="Abhi's WhatsApp Analyser", page_icon='📊')
        super().__init__()

    def show_analysis_btn(self):
        """
        Override the show_analysis_btn method from the Sidebar class.
        Show the analysis button and trigger the analysis when clicked.
        """
        if st.sidebar.button('Show Chat Analysis'):

            if not self.selected_user == 'Overall':
                col1, col2, col3 = st.columns(3)
                with col1:
                    st.write()

                with col2:
                    # Give custom padding at top
                    st.markdown(PADDING_TOP, unsafe_allow_html=True)

                    st.title("{}'s Analysis".format(self.selected_user))

                with col3:
                    st.write()

            else:
                col1, col2, col3 = st.columns(3)
                with col1:
                    st.write()

                with col2:
                    # Give custom padding at top
                    st.markdown(PADDING_TOP, unsafe_allow_html=True)

                    st.title('Overall Analysis')

                with col3:
                    st.write()

                self.group_specific_analysis = GroupSpecificAnalysis(
                    self.df, self.selected_user)

            self.plot = Plot(self.df, self.selected_user)

            st.divider()
            self.quick_metric()

            st.divider()
            self.plot.plot_daily_timeline()

            st.divider()
            self.plot.plot_timeline()

            st.divider()
            self.plot.plot_most_active_day_of_week()

            st.divider()
            self.plot.plot_most_active_month()

            self.plot_most_active_users()
            st.divider()

            self.plot.plot_word_cloud()
            st.divider()

            try:
                self.plot.plot_most_common_words()

            except Exception:
                st.write(
                    'The data you provided has fewer metrics to show more about the selected user.')

            st.divider()
            self.plot.plot_most_used_emoji()

            st.divider()
            self.plot.plot_activity_heatmap()

    def quick_metric(self):
        """
        Show quick metrics of the chat conversation.
        """
        SubHeader(
            subheader='Quick Metrics',
            tooltip='Quick overview of the entire chat.'
        )

        col1, col2, col3, col4 = st.columns(4)

        with col1:
            num_messages = self.analysis_obj.num_messages()
            st.metric(label='Total Messages', value=num_messages)

        with col2:
            total_words = self.analysis_obj.total_words()
            st.metric(label='Total Words', value=total_words)

        with col3:
            media_shared = self.analysis_obj.media_shared()
            st.metric(label='Media Shared', value=media_shared)

        with col4:
            links_shared = self.analysis_obj.links_shared()
            st.metric(label='Links Shared', value=links_shared)

    def plot_most_active_users(self):
        """
        Plot the most active users in the chat conversation.
        """
        if self.selected_user == 'Overall':
            st.divider()
            col1, col2 = st.columns(2)
            with col1:
                SubHeader(
                    subheader='Most Active Users (Percentage)',
                    tooltip='Most active user with percentage of chats.'
                )

                users = self.group_specific_analysis.most_active_users_percentage()
                st.dataframe(users)

            with col2:
                SubHeader(
                    subheader='Most Active Users',
                    tooltip='Most active user with number of chats.'
                )

                self.plot.plot_most_active_users()


if __name__ == '__main__':
    Main()