Update app.py

app.py

@@ -1,3 +1,6 @@
+"""
+Streamlit app containing the UI and the application logic.
+"""
 import datetime
 import logging
 import pathlib
@@ -68,7 +71,7 @@ def _get_icons_list() -> List[str]:
     """
     Get a list of available icons names without the dir name and file extension.
 
-    :return: A list of the icons.
+    :return: A llist of the icons.
     """
 
     return ice.get_icons_list()
@@ -99,7 +102,7 @@ def build_ui():
     Display the input elements for content generation.
     """
 
-    st.title("AI SlideMaker")
+    st.title(APP_TEXT['app_name'])
     st.subheader(APP_TEXT['caption'])
     st.markdown(
         '![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fhuggingface.co%2Fspaces%2Fbarunsaha%2Fslide-deck-ai&countColor=%23263759)'  # noqa: E501
@@ -118,11 +121,21 @@ def set_up_chat_ui():
 
     with st.expander('Usage Instructions'):
         st.markdown(GlobalConfig.CHAT_USAGE_INSTRUCTIONS)
+        st.markdown(
+            '[SlideDeck AI](https://github.com/barun-saha/slide-deck-ai) is an Open-Source project.'  # noqa: E501
+            ' It is is powered by'  # noqa: E501
+            ' [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407).'  # noqa: E501
+        )
 
     st.info(
-        "This is part of an FYP project (module 1)."
+        'If you like SlideDeck AI, please consider leaving a heart ❤️ on the'
+        ' [Hugging Face Space](https://huggingface.co/spaces/barunsaha/slide-deck-ai/) or'
+        ' a star ⭐ on [GitHub](https://github.com/barun-saha/slide-deck-ai).'
+        ' Your [feedback](https://forms.gle/JECFBGhjvSj7moBx9) is appreciated.'
     )
 
+    # view_messages = st.expander('View the messages in the session state')
+
     st.chat_message('ai').write(
         random.choice(APP_TEXT['ai_greetings'])
     )
@@ -136,6 +149,8 @@ def set_up_chat_ui():
 
     prompt_template = ChatPromptTemplate.from_template(template)
 
+    # Since Streamlit app reloads at every interaction, display the chat history
+    # from the save session state
     for msg in history.messages:
         msg_type = msg.type
         if msg_type == 'user':
@@ -188,6 +203,7 @@ def set_up_chat_ui():
             for chunk in _get_llm().stream(formatted_template):
                 response += chunk
 
+                # Update the progress bar
                 progress_percentage = min(
                     len(response) / GlobalConfig.LLM_MODEL_MAX_OUTPUT_LENGTH, 0.95
                 )
@@ -223,13 +239,18 @@ def set_up_chat_ui():
         history.add_user_message(prompt)
         history.add_ai_message(response)
 
+        # The content has been generated as JSON
+        # There maybe trailing ``` at the end of the response -- remove them
+        # To be careful: ``` may be part of the content as well when code is generated
         response_cleaned = text_helper.get_clean_json(response)
 
         logger.info(
             'Cleaned JSON response:: original length: %d | cleaned length: %d',
             len(response), len(response_cleaned)
         )
+        # logger.debug('Cleaned JSON: %s', response_cleaned)
 
+        # Now create the PPT file
         progress_bar.progress(
             GlobalConfig.LLM_PROGRESS_MAX,
             text='Finding photos online and generating the slide deck...'
@@ -254,7 +275,7 @@ def generate_slide_deck(json_str: str) -> Union[pathlib.Path, None]:
     deck, the path may be to an empty file.
 
     :param json_str: The content in *valid* JSON format.
-    :return: The path to the .pptx file or None in case of error.
+    :return: The path to the .pptx file or `None` in case of error.
     """
 
     try:
@@ -305,77 +326,99 @@ def generate_slide_deck(json_str: str) -> Union[pathlib.Path, None]:
     else:
         temp = tempfile.NamedTemporaryFile(delete=False, suffix='.pptx')
         path = pathlib.Path(temp.name)
-        st.session_state[DOWNLOAD_FILE_KEY] = path
+        st.session_state[DOWNLOAD_FILE_KEY] = str(path)
+
+        if temp:
+            temp.close()
 
-    pptx_helper.create_pptx_from_json(parsed_data, pptx_template, path)
+    try:
+        logger.debug('Creating PPTX file: %s...', st.session_state[DOWNLOAD_FILE_KEY])
+        pptx_helper.generate_powerpoint_presentation(
+            parsed_data,
+            slides_template=pptx_template,
+            output_file_path=path
+        )
+    except Exception as ex:
+        st.error(APP_TEXT['content_generation_error'])
+        logger.error('Caught a generic exception: %s', str(ex))
 
     return path
 
 
-def _display_download_button(path: pathlib.Path):
+def _is_it_refinement() -> bool:
     """
-    Show a download button for the PPTX file.
+    Whether it is the initial prompt or a refinement.
 
-    :param path: The path to the .pptx file.
+    :return: True if it is the initial prompt; False otherwise.
     """
 
-    file_name = path.name
-    current_time = datetime.datetime.now()
-    timestamp = current_time.strftime('%Y-%m-%d')
+    if IS_IT_REFINEMENT in st.session_state:
+        return True
 
-    with open(path, 'rb') as out_file:
-        st.download_button(
-            label='Download Your Slide Deck!',
-            data=out_file,
-            file_name=f'{file_name[:-5]}_{timestamp}.pptx',
-            mime='application/vnd.openxmlformats-officedocument.presentationml.presentation'
-        )
+    if len(st.session_state[CHAT_MESSAGES]) >= 2:
+        # Prepare for the next call
+        st.session_state[IS_IT_REFINEMENT] = True
+        return True
 
+    return False
 
-def _is_it_refinement() -> bool:
+
+def _get_user_messages() -> List[str]:
     """
-    Whether the slide deck is a refinement of a previous response.
+    Get a list of user messages submitted until now from the session state.
 
-    :return: True if the slide deck is a refinement.
+    :return: The list of user messages.
     """
 
-    return IS_IT_REFINEMENT in st.session_state and st.session_state[IS_IT_REFINEMENT]
+    return [
+        msg.content for msg in st.session_state[CHAT_MESSAGES] if isinstance(msg, HumanMessage)
+    ]
 
 
-def _get_user_messages() -> List[str]:
+def _get_last_response() -> str:
     """
-    Return all user messages from the session state.
+    Get the last response generated by AI.
 
-    :return: A list of user messages.
+    :return: The response text.
     """
 
-    return [
-        msg.content for msg in st.session_state[CHAT_MESSAGES]
-        if msg.type == 'user'
-    ]
+    return st.session_state[CHAT_MESSAGES][-1].content
 
 
-def _get_last_response() -> str:
+def _display_messages_history(view_messages: st.expander):
     """
-    Get the last AI message.
+    Display the history of messages.
 
-    :return: The AI's last message.
+    :param view_messages: The list of AI and Human messages.
     """
 
-    return [
-        msg.content for msg in st.session_state[CHAT_MESSAGES]
-        if msg.type == 'ai'
-    ][-1]
+    with view_messages:
+        view_messages.json(st.session_state[CHAT_MESSAGES])
 
-# App entry point
-if __name__ == '__main__':
-    st.set_page_config(
-        page_title="AI SlideMaker",
-        layout="centered",
-        initial_sidebar_state="expanded",
-        menu_items={
-            'About': 'This project is an FYP project (module 1).'
-        }
-    )
+
+def _display_download_button(file_path: pathlib.Path):
+    """
+    Display a download button to download a slide deck.
+
+    :param file_path: The path of the .pptx file.
+    """
+
+    with open(file_path, 'rb') as download_file:
+        st.download_button(
+            'Download PPTX file ⬇️',
+            data=download_file,
+            file_name='Presentation.pptx',
+            key=datetime.datetime.now()
+        )
+
+
+def main():
+    """
+    Trigger application run.
+    """
 
     build_ui()
+
+
+if __name__ == '__main__':
+    main()