feat(main.py): refactor code to improve readability and error handling

feat(main.py): integrate streamlit for better UI and logging for better debugging
feat(main.py): add argparse for command line arguments
feat(main.py): change file extensions from .txt to .md for better readability
feat(main.py): add new prompts and results directories for better organization
feat(main.py): add .gitignore to ignore .venv directory
feat(main.py): add openai_apikey.md and problems.md for storing API key and problems respectively
The code in main.py has been refactored to improve readability and error handling. Streamlit has been integrated to provide a better user interface and logging has been added for better debugging. Argparse has been added to handle command line arguments. The file extensions have been changed from .txt to .md for better readability in text editors that support markdown. New directories for prompts and results have been added for better organization of files. A .gitignore file has been added to ignore the .venv directory which contains virtual environment files. The openai_apikey.md and problems.md files have been added to store the OpenAI API key and problems respectively.

Author: Sébastien Fichot

.gitignore

@@ -0,0 +1,4 @@
+.venv
+results/*.md
+solution_*.md
+debug.txt

main.py

@@ -1,52 +1,86 @@
 import openai
 import os
-import requests
-import re
-from time import sleep
 import time
+import logging
+import argparse
+import streamlit as st
+
+# Set up logging
+logging.basicConfig(level=logging.INFO)
 
 # Define a function to open a file and return its contents as a string
-def open_file (filepath) :
-    with open (filepath, 'r', encoding='utf-8') as infile:
-        return infile.read ()
+def open_file(filepath):
+    try:
+        with open(filepath, 'r', encoding='utf-8') as infile:
+            return infile.read()
+    except IOError as e:
+        logging.error(f'Error opening file {filepath}: {e}')
+        raise e
+
+# Define a function to save content to a file
+def save_file(filepath, content, mode='w'):
+    try:
+        with open(filepath, mode, encoding='utf-8') as outfile:
+            outfile.write(content)
+    except IOError as e:
+        logging.error(f'Error writing to file {filepath}: {e}')
+
+def save_debug(content):
+    try:
+        save_file('debug.txt', content, 'a')
+    except IOError as e:
+        logging.error(f'Error writing to file {filepath}: {e}')
 
-#Define a function to save content to a file
-def save_file (filepath, content):
-    with open (filepath, 'w', encoding='utf-8') as outfile:
-        outfile.write (content)
 
 # Set the OpenAI API keys by reading them from files
-api_key = open_file ('openai apikey2.txt')
+api_key = open_file('openai_apikey.md')
+
+page_title = '# Chain Prompt + Tree of Thoughts 🎈'
+
+st.set_page_config(page_title=page_title, page_icon=None, layout="wide", initial_sidebar_state="auto", menu_items=None)
+
+st.markdown(page_title)
+
+col1, col2 = st.columns([1, 4])
+col1.subheader("Auto")
+col2.subheader("Result")
+bar = col2.progress(0)
 
 class ScriptRunner:
-    def __init__ (self):
+    def __init__(self, loop_count):
         self.current_progress = 0
+        self.loop_count = loop_count
+        self.conversation = []
+        self.problem = ""
+        self.evidea2 = ""
 
-    def update progress (self, value);
+    def update_progress(self, value):
         self.current_progress = value
+        bar.progress(value)
 
-    def get_solution (self):
+    def get_solution(self):
         if self.conversation:
             assistant_messages = ""
             for msg in self.conversation:
-                if msg ['role'] = 'assistant':
+                if msg['role'] == 'assistant':
                     assistant_messages += msg['content'] + "\n"
             return assistant_messages.strip()
         return 'Solution not yet available.'
 
-    def get_chain_results (self):
+    def get_chain_results(self):
         chain_results = {}
-        for i in range (1, 8):
-            if os. path.exists (f'chain{i}.txt');
-                chain_results [f'chain{i}'] = open_file(f'chain{i}.txt')
-            return chain_results
+        for i in range(1, 8):
+            if os.path.exists(f'chain{i}.md'):
+                chain_results[f'chain{i}'] = open_file(f'chain{i}.md')
+        return chain_results
 
     def get_chat_response (self):
-        eturn self.chat_response
+        return self.chat_response
 
     def get_conversation_history (self):
         return "\n".join([f"{message['role'].capitalize()}: {message['content']}" for message in self.conversation])
 
+
     def chatgpt(self, api_key, conversation, chatbot, user_input, temperature=0.7, frequency_penalty=0.2, presence_penalty=0, max_retry=5):
         # Set the API key
         openai.api_key = api_key
@@ -62,6 +96,9 @@ def chatgpt(self, api_key, conversation, chatbot, user_input, temperature=0.7, f
         retry = 0
         while True:
             try:
+                save_debug(f'retry: {retry}\n')
+                save_debug(f'messages_input: {messages_input}\n')
+
                 # Make an API call to the Chat Completion endpoint with the updated messages
                 completion = openai.ChatCompletion.create(
                     model="gpt-4",
@@ -74,108 +111,159 @@ def chatgpt(self, api_key, conversation, chatbot, user_input, temperature=0.7, f
                 # Extract the assistant's message and add it to the conversation
                 message = completion['choices'][0]['message']['content']
                 conversation.append({"role": "assistant", "content": message})
+                save_debug(f'message: {message}\n')
+                save_debug('----\n')
                 return message
-            except openai.api_resources.completion.ChatCompletion.CreateError as e:
+
+            except openai.error.RateLimitError as e:
                 if e.error['message'] == 'Rate limit exceeded' and retry < max_retry:
-                    time.sleep(1)  # Sleep for 1 second before retrying
+                    retry_time = e.retry_after if hasattr(e, 'retry_after') else 3
+                    print(f'Rate limit exceeded. Sleeping for {retry_time} seconds...')
+                    time.sleep(retry_time)
                     retry += 1
                 else:
                     raise e
-            time.sleep(1)  # Sleep for 1 second before retrying
+
+            except openai.error.ServiceUnavailableError as e:
+                retry_time = 10  # Adjust the retry time as needed
+                print(f'Service is unavailable. Retrying in {retry_time} seconds...')
+                time.sleep(retry_time)
+                retry += 1
+
+            except openai.error.APIError as e:
+                retry_time = e.retry_after if hasattr(e, 'retry_after') else 10
+                print(f'API error occurred. Retrying in {retry_time} seconds...')
+                time.sleep(retry_time)
+                retry += 1
+
+            except OSError as e:
+                retry_time = 5  # Adjust the retry time as needed
+                print(f'Connection error occurred: {e}. Retrying in {retry_time} seconds...')
+                time.sleep(retry_time)
+                retry += 1
+
+    def chain_process(self, prompt_file, save_file_name, replacements, api_key, conversation, chatbot):
+        prompt = open_file(prompt_file)
+        for placeholder, value in replacements.items():
+            prompt = prompt.replace(placeholder, value)
+
+        col1.markdown(f'- {prompt_file}')
+
+        result = self.chatgpt(api_key, conversation, chatbot, prompt)
+        save_file(save_file_name, result)
+
+        with col2.expander(save_file_name):
+            st.markdown(f'Prompt: {prompt_file}')
+            st.markdown(f'File: {save_file_name}')
+            st.markdown(result)
+
+        return result
 
     def run_loop(self):
-        for i in range (3): # change the number here to adjust the number of iterations
+        for i in range(self.loop_count):
             # Create a new conversation list for each iteration
             conversation_iteration = []
-            
+
             # Summary Chain 3
-            win1 = open_file('prompt3.txt').replace('<<WINNINGIDEA>>', self.evidea2)
-            print(win1)
-            win2 = self.chatgpt (api_key, conversation_iteration, "Assistant", win1)
-            save_file('winning1_{}.txt'.format(i), win2)
-            print (win2)
+            replacements = {'<<WINNINGIDEA>>': self.evidea2}
+            win2 = self.chain_process('prompts/discriminate.md', f'results/loop_{i}_discriminated.md', replacements, api_key, conversation_iteration, "Assistant")
             self.update_progress(20 + 20 * i)
 
             # Summary Chain 4
-            loopidea = open_file('prompt1-5.txt').replace('<<PROBLEM>>', self.problem).replace('<<WINNING2>>', win2)
-            print(loopidea)
-            loopidea2 = self.chatgpt(api_key, conversation_iteration, "Assistant", loopidea) 
-            save_file('winningloop_{}.txt'.format(i), loopidea2)
-            print (loopidea2)
+            replacements = {'<<PROBLEM>>': self.problem, '<<WINNING2>>': win2}
+            loopidea2 = self.chain_process('prompts/brainstorm.md', f'results/loop_{i}_brained.md', replacements, api_key, conversation_iteration, "Assistant")
             self.update_progress(40 + 20 * i)
 
             # Summary Chain 5
-            loopidea3 = open_file('prompt2-5.txt').replace('<<WLOOP>>', loopidea2) 
-            print (loopidea3)
-            loopidea4 = self.chatgpt (api_key, conversation_iteration, "Assistant", loopidea3) 
-            save_file('winningloop2_().txt'.format (i), loopidea4)
-            print (loopidea4)
+            replacements = {'<<WLOOP>>': loopidea2}
+            loopidea4 = self.chain_process('prompts/evaluate.md', f'results/loop_{i}_evaluated.md', replacements, api_key, conversation_iteration, "Assistant")
             self.update_progress(60 + 20 * i)
 
-def run_script(self):
-    self.conversation = []
-    self.problem = open_file('problems.txt')
-    # Create a new conversation list
-    conversation = []
-
-    # Summary Chain 1
-    idea = open_file('prompt1.txt').replace('<<PROBLEM>>', self.problem) 
-    print(idea)
-    idea2 = self.chatgpt(api_key, conversation, "Assistant", idea) 
-    save_file('ideas1.txt', idea2)
-    print (idea2)
-    self.update_progress(5)
-
-    # Summary Chain 2
-    evidea = open_file('prompt2.txt').replace('<<3IDEAS>>', idea2) 
-    print(evidea)
-    self.evidea2 = self.chatgpt(api_key, conversation, "Asaistant", evidea) 
-    save_file('evideas1.txt', self.evidea2)
-    print (self.evidea2)
-    self.update_progress(10)
-
-    # Summary Chain 3
-    win1 = open_file('prompt3.txt').replace('<<WINNINGIDEA>>', self.evidea2)
-    print(win1)
-    win2 = self.chatgpt(api_key, conversation, "Assistant", win1)
-    save_file('winning1.txt', win2)
-    print(win2)
-    self.update_progress(20)
-
-    # Summary Chain 4
-    loopidea = open_file('prompt1-5.txt').replace('<<PROBLEM>>', self.problem).replace('<<WINNING2>>', win2)
-    print(loopidea)
-    loopidea2 = self.chatgpt (api_key, conversation, "Assistant", loopidea)
-    save_file('winningloop.txt', loopidea2)
-    print(loopidea2)
-    self.update_progress(30)
-
-    # Summary Chain 5
-    loopidea3 = open_file('prompt2-5.txt').replace('<<WLOOP>>', loopidea2) 
-    print(loopidea3)
-    loopidea4 = self.chatgpt (api_key, conversation, "Assistant", loopidea3)
-    save_file('winningloop2.txt', loopidea4)
-    print(loopidea4)
-    self.run_loop()
-    self.update_progress(60)
-
-    # Summary Chain 6
-    winner = open_file('winning1_3.txt')
-    winner2 = open_file('winnerprompt.txt').replace('<<WINNER>>', winner) 
-    print(winner2)
-    winner3 = self.chatgpt(api_key, conversation, "Assistant", winner2) 
-    save_file('winnerdeep.txt', winner3)
-    print(winner3)
-    self.update_progress(80)
-
-    # Summary Chain 7
-    winner4 = open_file('finalprompt.txt').replace('<<WINNER2>>', winner3) # 184 --
-    print(winner4)
-    winner5 = self.chatgpt(api_key, conversation, "Assistant", winner4) 
-    save_file('winnerfinal.txt', winner5)
-    print(winner5)
-    self.update_progress(100)
-    
-    # Print out the results of each chain
-    for chain, result in self.get_chain_results().items():
-        print(f"{chain}: {result}")
+    def run_script(self):
+        self.problem = open_file('problems.md')
+
+        col2.markdown("Problems")
+        col2.markdown(self.problem)
+
+        conversation = []
+
+        # Summary Chain 1
+        replacements = {'<<PROBLEM>>': self.problem}
+        idea2 = self.chain_process('prompts/brainstorm-initial.md', 'results/brainstormed.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(5)
+
+        # Summary Chain 2
+        replacements = {'<<3IDEAS>>': idea2}
+        self.evidea2 = self.chain_process('prompts/evaluate-initial.md', 'results/evaluated.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(10)
+
+        # Summary Chain 3
+        replacements = {'<<WINNINGIDEA>>': self.evidea2}
+        win2 = self.chain_process('prompts/discriminate.md', 'results/discriminated.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(20)
+
+        # Summary Chain 4
+        replacements = {'<<PROBLEM>>': self.problem, '<<WINNING2>>': win2}
+        loopidea2 = self.chain_process('prompts/brainstorm.md', 'results/brainstormed-2.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(30)
+
+        # Summary Chain 5
+        replacements = {'<<WLOOP>>': loopidea2}
+        loopidea4 = self.chain_process('prompts/evaluate.md', 'results/evaluated-2.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(60)
+
+        self.run_loop()
+
+        # Summary Chain 6
+        winner = open_file(f'results/loop_{self.loop_count - 1}_evaluated.md')
+        replacements = {'<<WINNER>>': winner}
+        winner3 = self.chain_process('prompts/deepen-win.md', 'results/win-deepened.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(80)
+
+        # Summary Chain 7
+        replacements = {'<<WINNER2>>': winner3}
+        winner5 = self.chain_process('prompts/justify-win.md', 'results/win-justified.md', replacements, api_key, conversation, "Assistant")
+        self.update_progress(95)
+
+        # Create a solution.md
+        timestr = time.strftime("%Y-%m-%d_%H-%M-%S")
+        solution_file_name = f'solution_{timestr}.md'
+        save_file(solution_file_name, '# SOLUTIONS\n\n', 'w')
+        save_file(solution_file_name, '## Stated problems\n\n', 'a')
+        save_file(solution_file_name, self.problem, 'a')
+        save_file(solution_file_name, '\n\n', 'a')
+        save_file(solution_file_name, '## Initial brainstorm\n\n', 'a')
+        save_file(solution_file_name, self.evidea2, 'a')
+        save_file(solution_file_name, '\n\n', 'a')
+        save_file(solution_file_name, '## Second brainstorm\n\n', 'a')
+        save_file(solution_file_name, loopidea2, 'a')
+        save_file(solution_file_name, '\n\n', 'a')
+        save_file(solution_file_name, '## Second brainstorm\n\n', 'a')
+        save_file(solution_file_name, loopidea2, 'a')
+        save_file(solution_file_name, '\n\n', 'a')
+        save_file(solution_file_name, f'## Solution\n', 'a')
+        save_file(solution_file_name, f'After {self.loop_count} iterations, we deepened the thoughts on the solution.\n\n', 'a')
+        save_file(solution_file_name, winner3, 'a')
+        save_file(solution_file_name, '\n\n', 'a')
+        save_file(solution_file_name, f'## Final thoughts on the solution\n\n', 'a')
+        save_file(solution_file_name, winner5, 'a')
+        self.update_progress(100)
+
+        # Print out the results of each chain
+        for chain, result in self.get_chain_results().items():
+            logging.info(f'{chain}: {result}')
+            with st.sidebar:
+                st.divider()
+                st.markdown(chain)
+                st.divider()
+                st.markdown(result)
+                st.divider()
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Run the script with a specific number of loops.')
+    parser.add_argument('--loops', type=int, default=3, help='The number of loops to run.')
+    args = parser.parse_args()
+
+    runner = ScriptRunner(loop_count=args.loops)
+    runner.run_script()

problems.md

@@ -0,0 +1 @@
+I am a new Tech Lead in a company which operates over the Spotify organization model (Squads, Chapters, and Matrices). I will operate within a team of Tech Leads. What should I focus on for the first 30 days?

prompts/brainstorm-initial.md

@@ -0,0 +1,3 @@
+Here is the problem : <<PROBLEM>>
+
+Could you brainstorm 3 creative distinct solutions? Please consider the 3 factors that has the most impact on the outcome.

prompts/brainstorm.md

@@ -0,0 +1,5 @@
+Here is the problem:
+
+<<PROBLEM>> 
+ 
+Could you brainstorm 2 new creative distinct solutions and include the following idea <<WINNING2>> so we now have 3 ideas. Please consider the 3 factors that has the most impact on the outcome.

prompts/deepen-win.md

@@ -0,0 +1,3 @@
+For the winning solution, deepen the thought process. Generate potential scenarios, strategies for implementation, any necessary partnerships or resources, and how potential obstacles might be overcome. Also, consider any potential unexpected outcomes and how they might be handled.
+Winning solution:
+<<WINNER>>

prompts/discriminate.md

@@ -0,0 +1,5 @@
+Here are the ideas:
+
+<<WINNINGIDEA>>
+
+Remove to 2 lowest rated Ideas and keep and rewrite a compressed summary of ONLY the higest rated idea including the probability score.