gptgui.py

'''
gptgui.py 1.3
    by Michael Leidel
remarks:
    modified API for openai >=1.3.3

'''
import os
import sys
import time
import signal
import configparser
import subprocess
import webbrowser
import markdown
import platform
from tkinter.font import Font
from tkinter import messagebox
from ttkbootstrap import *
from ttkbootstrap.constants import *
from ttkbootstrap.tooltip import ToolTip
import datetime
from openai import OpenAI

class Application(Frame):
    ''' main class docstring '''
    def __init__(self, parent):
        Frame.__init__(self, parent)
        self.pack(fill=BOTH, expand=True, padx=4, pady=4)
        self.Saved = True
        # get settings from ini file
        config = configparser.ConfigParser()
        config.read('gptgui.ini')
        self.MyTheme = config['Main']['theme']
        self.MyPath = config['Main']['path']
        self.MyFntQryF = config['Main']['fontqryfam']
        self.MyFntQryZ = config['Main']['fontqrysiz']
        self.MyFntGptF = config['Main']['fontgptfam']
        self.MyFntGptZ = config['Main']['fontgptsiz']
        self.MyModel = config['Main']['engine']
        self.MyTemp = config['Main']['temperature']
        self.MyTokens = config['Main']['tokens']
        self.MyKey = config['Main']['gptkey']
        self.MyTime = config['Main']['showtime']
        self.MySave = config['Main']['autosave']
        self.MyEditor = config['Main']['editor']
        self.MyFile = config['Main']['tempfile']
        self.MySystem = config['Main']['system']
        self.TOPFRAME = int(config['Main']['top_frame'])
        if len(self.MyKey) < 16:
            self.MyKey = os.environ.get(self.MyKey)  # Using ENV var instead of actual key string.

        self.create_widgets()

    def create_widgets(self):
        ''' creates GUI for app '''
        # expand widget to fill the grid
        self.columnconfigure(1, weight=1, pad=5)
        self.columnconfigure(2, weight=1, pad=5)
        self.rowconfigure(2, weight=1, pad=5)

        self.query = Text(self)
        self.query.grid(row=1, column=1, columnspan=2, sticky='nsew')
        efont = Font(family=self.MyFntQryF, size=self.MyFntQryZ)
        self.query.configure(font=efont)
        self.query.config(wrap="word", # wrap=NONE
                          undo=True, # Tk 8.4
                          width=50,
                          height=self.TOPFRAME,
                          padx=5, # inner margin
                          #insertbackground='#000',   # cursor color
                          tabs=(efont.measure(' ' * 4),))

        self.scrolly = Scrollbar(self, orient=VERTICAL,
                                 command=self.query.yview)
        self.scrolly.grid(row=1, column=3, sticky='ns')  # use nse
        self.query['yscrollcommand'] = self.scrolly.set

        self.txt = Text(self)
        self.txt.grid(row=2, column=1, columnspan=2, sticky='nsew')
        efont = Font(family=self.MyFntGptF, size=self.MyFntGptZ)
        self.txt.configure(font=efont)
        self.txt.config(wrap="word", # wrap=NONE
                        undo=True, # Tk 8.4
                        width=50,
                        height=12,
                        padx=5, # inner margin
                        #insertbackground='#000',   # cursor color
                        tabs=(efont.measure(' ' * 4),))

        self.scrolly = Scrollbar(self, orient=VERTICAL, command=self.txt.yview)
        self.scrolly.grid(row=2, column=3, sticky='ns')  # use nse
        self.txt['yscrollcommand'] = self.scrolly.set

        # BUTTON FRAME
        btn_frame = Frame(self)
        btn_frame.grid(row=4, column=1, sticky='w')

        self.clear = Button(btn_frame, text='Clear', command=self.on_clear_all)
        self.clear.grid(row=1, column=2, sticky='w',
                   pady=(5, 0), padx=(5, 7))

        self.save = Button(btn_frame, text='Save', command=self.on_save_file)
        self.save.grid(row=1, column=3, sticky='w',
                   pady=(5, 0), padx=5)

        self.view = Button(btn_frame, text='View', command=self.on_view_file)
        self.view.grid(row=1, column=4, sticky='w',
                   pady=(5, 0))

        self.purge = Button(btn_frame, text='Purge', command=self.on_purge)
        self.purge.grid(row=1, column=5, sticky='w',
                   pady=(5, 0), padx=5)

        self.open = Button(btn_frame, text='Text', command=self.on_md_open)
        self.open.grid(row=1, column=6, sticky='w',
                     pady=(5, 0), padx=5)

        self.md = Button(btn_frame, text='Html', command=self.on_md_render)
        self.md.grid(row=1, column=7, sticky='w',
                     pady=(5, 0), padx=(0, 5))

        self.opts = Button(btn_frame, text='Options', command=self.options)
        self.opts.grid(row=1, column=8, sticky='w',
                   pady=(5, 0), padx=5)

        self.sub = Button(btn_frame,
                     text='Submit Query (Ctrl-g)',
                     command=self.on_submit, width=20)
        self.sub.grid(row=1, column=9, sticky='w',
                   pady=(5, 0), padx=(20, 0))

       # END BUTTON FRAME

        cls = Button(self, text='Close', command=self.exit_program)
        cls.grid(row=4, column=2, columnspan=2, sticky='e',
                 pady=(5,0), padx=5)

        # Popup menus - for self.query Text widgets
        self.popup_query = Menu(tearoff=0, title="title")
        self.popup_query.add_command(label="Copy",
                               command=lambda: self.popquery(1))
        self.popup_query.add_command(label="Paste",
                               command=lambda: self.popquery(2))
        self.popup_query.add_separator()
        self.popup_query.add_command(label="Copy All",
                                     command=lambda: self.popquery(3))
        self.popup_query.add_separator()
        self.popup_query.add_command(label="Larger",
                                     command=lambda: self.popquery(4))
        self.popup_query.add_command(label="Smaller",
                                     command=lambda: self.popquery(5))
        self.popup_query.add_separator()
        self.popup_query.add_command(label="Browser",
                                     command=lambda: self.popquery(6))
        self.query.bind("<Button-3>", self.do_pop_query)

        # Popup menus - for self.txt Text widgets
        self.popup_txt = Menu(tearoff=0, title="title")
        self.popup_txt.add_command(label="Copy",
                               command=lambda: self.poptxt(1))
        self.popup_txt.add_command(label="Paste",
                               command=lambda: self.poptxt(2))
        self.popup_txt.add_separator()
        self.popup_txt.add_command(label="Copy All",
                                     command=lambda: self.poptxt(3))
        self.txt.bind("<Button-3>", self.do_pop_txt)


        # Bindings
        root.bind("<Control-t>", self.show_tokens)  # Show result tokens in title
        root.bind("<Control-m>", self.on_toggle_time)  # time elapsed toggle
        root.bind("<Control-h>", self.on_kb_help)  # show hotkey help
        root.bind("<Control-q>", self.exit_program)  # Close button
        root.bind("<Control-s>", self.on_save_file)  # Save button
        root.bind("<Control-g>", self.on_submit)  # Submit Query button
        root.bind("<Control-Return>", self.on_submit)  # Submit Query button
        root.bind("<Control-Shift-S>", self.speak_text)  # speak query response
        root.bind("<Escape>", self.speak_text_cancel)  # stop speaking


        # ToolTips
        ToolTip(self.clear,
                text="Erase window text",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.view,
                text="View saved text in window",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.save,
                text="Append current text",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.purge,
                text="Remove all saved text",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.sub,
                text="Ctrl-Enter to Append",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.md,
                text="markdown to browser",
                bootstyle=(INFO, INVERSE),
                wraplength=140)
        ToolTip(self.open,
                text="markdown to text editor",
                bootstyle=(INFO, INVERSE),
                wraplength=140)

        if self.MySave == "1":
            self.save.config(text="Auto Save", bootstyle="default-outline")
        self.query.focus_set()

#       check if query entered on command line
#       if it query entered on command line
#       then execute it immediately
        if len(sys.argv) > 1:
            query = " ".join(sys.argv[1:])
            self.query.insert("1.0", query)
            self.on_submit()
        else:
            self.txt.delete("1.0", END)
            self.txt.insert("1.0", "Ctrl-h for help")


#----------------------------------------------------------------------

    def on_submit(self, e=None):
        ''' Query OpenAI Gpt engine and display response in Text widgit'''
        if e is None:
            renderStyle = "X"
        else:
            renderStyle = e.keysym  # "Return" means append to Output Text
        start = time.time()  # time the Gpt retrival
        querytext = self.query.get("1.0", END)
        if len(querytext) < 4:
            return
        if self.MySave == "0":
            self.save.configure(bootstyle=DEFAULT) # new - not been saved
            self.Saved = False
        # get the Gpt key from the ini value
        try:
            client = OpenAI(
            api_key = self.MyKey  # openai API
            )
        except Exception as e:
            messagebox.showerror("Could Not Read Key file",
                       "Did you enter your Gpt Key?")
            return

        # openai API request code
        try:
            response = client.chat.completions.create(
                model=self.MyModel,
                max_tokens=int(self.MyTokens),
                temperature=float(self.MyTemp),
                messages=[{"role": "system", "content": self.MySystem},
                    {"role": "user", "content" : querytext.strip()}
                ]
            )

            # display Gpt response in Text widget

            output = response.choices[0].message.content + "\n\n"
            # collect response token info
            self.length = len(output)
            self.completion = response.usage.completion_tokens
            self.total = response.usage.total_tokens
            self.prompt = response.usage.prompt_tokens
            # # display response text
            if self.MyTime == "1" :
                self.elapsed = (time.time() - start)
                output = f"elapsed time: {round(self.elapsed, 5)}\n-----\n" + output
            if renderStyle != "Return":
                self.txt.delete("1.0", END)
                self.txt.insert("1.0", output)
            else:
                # self.txt.mark_set(INSERT, END)
                self.txt.insert(END, output)
            # on Auto Save do the save
            if self.MySave == "1":
                self.on_save_file()
        except Exception as e:
            messagebox.showerror("Problems", e)
            print("Key=", self.MyKey)

    def on_purge(self):
        ''' User is purging the query-save file '''
        if not os.path.isfile(self.MyPath):
            messagebox.showwarning(self.MyPath, "Empty - No File to purge")
            return
        ret = messagebox.askokcancel("Purge", "Delete All Saved Queries?")
        if ret is True:
            os.remove(self.MyPath)
            messagebox.showinfo("Purge", "Saved Queries Deleted.")


    def on_clear_all(self):
        ''' User is clearning the GUI fields '''
        if self.Saved is False:
            if messagebox.askokcancel('GptGUI',
                                      'Last response not saved - continue?') is False:
                return

        self.txt.delete("1.0", END)
        self.query.delete("1.0", END)
        self.save.configure(bootstyle=DEFAULT) # new - not been saved
        self.Saved = True


    def on_save_file(self, e=None):
        ''' Save the current query and result to user file (MyPath) '''
        resp = self.txt.get("1.0", END).strip()
        qury = self.query.get("1.0", END).strip()
        if qury == "" or resp == "":  # make sure there is a query present
            return
        try:
            msg = "  \ncompletion tokens: " + str(self.completion) + \
                  "  \ntotal tokens: " + str(self.total) + \
                  "  \nprompt tokens: " + str(self.prompt) + "\n-----\n"
            with open(self.MyPath, "a") as fout:
                fout.write(str(now.strftime("%Y-%m-%d %H:%M  \n")))
                fout.write(qury + "  \nengine: " + MyModel)
                fout.write(msg)
                fout.write(resp.strip() + "\n\n---\n\n")
        except Exception as e:
            messagebox.showerror("Save Query Problem", e)

        if self.MySave == "0":  # Auto Save is off
            # indicate that a "save" has processed
            self.save.configure(bootstyle="default-outline")
            self.Saved = True


    def on_view_file(self):
        ''' View the user saved queries file '''
        if not os.path.isfile(self.MyPath):
            messagebox.showwarning(self.MyPath, "Empty - No File")
            return
        if self.Saved is False:
            if messagebox.askokcancel('GptGUI',
                                      'Last response not saved - continue?') is False:
                return
        # Either the user has or has-not saved the current query reponse.
        # Therefore, set the "Save" button back to DEFAULT because
        # if the response was not saved prior, then it is just lost.
        self.Saved = True
        self.save.configure(bootstyle=DEFAULT)
        self.txt.delete("1.0", END)
        with open(self.MyPath, "r") as fin:
            self.txt.insert("1.0", fin.read())
        self.query.delete("1.0", END)


    def options(self, e=None):
        ''' Launch Options program and exit this program '''
        if platform.system() == "Windows":
            subprocess.call(["pythonw.exe", "gptopt.py"])
        else:
            subprocess.call(["python3", "gptopt.py"])
        # re-read configuration
        config = configparser.ConfigParser()
        config.read('gptgui.ini')
        self.MyTheme = config['Main']['theme']
        self.MyPath = config['Main']['path']
        self.MyFntQryF = config['Main']['fontqryfam']
        self.MyFntQryZ = config['Main']['fontqrysiz']
        self.MyFntGptF = config['Main']['fontgptfam']
        self.MyFntGptZ = config['Main']['fontgptsiz']
        self.MyModel = config['Main']['engine']
        self.MyTemp = config['Main']['temperature']
        self.MyTokens = config['Main']['tokens']
        self.MyKey = config['Main']['gptkey']
        self.MyTime = config['Main']['showtime']
        self.MySave = config['Main']['autosave']
        self.MyEditor = config['Main']['editor']
        self.MyFile = config['Main']['tempfile']
        self.MySystem = config['Main']['system']
        self.TOPFRAME = int(config['Main']['top_frame'])
        if len(self.MyKey) < 16:
            self.MyKey = os.environ.get(self.MyKey)  # Using ENV var instead of actual key string.
        # re-set the items and change font/size
        efont = Font(family=self.MyFntQryF, size=self.MyFntQryZ)
        self.query.configure(font=efont, height=self.TOPFRAME)
        efont = Font(family=self.MyFntGptF, size=self.MyFntGptZ)
        self.txt.configure(font=efont)
        style = Style()
        style = Style(theme=self.MyTheme)
        MyTitle = "GptGUI (OpenAI) " + self.MyModel + " " + str(self.MyTokens) + " " + str(self.MyTemp)
        root.title(MyTitle)


    def show_tokens(self, e=None):
        ''' show response tokens '''
        msg = "text length: " + str(self.length) + \
              "\ncompletion tokens: " + str(self.completion) + \
              "\ntotal tokens: " + str(self.total) + \
              "\nprompt tokens: " + str(self.prompt)
        if self.MyTime == "1":
            msg += "\nResponse Time Elapsed: " + str(self.elapsed)
        messagebox.showinfo("GptGUI Response Tokens", msg)

    def on_toggle_time(self, e=None):
        ''' Toggles the showing of the response time '''
        if self.MyTime == "1":
            self.MyTime = "0"
        else:
            self.MyTime = "1"
        messagebox.showinfo("Toggle Show Elapsed Time",
                            "    Set to " + self.MyTime + "       ")

    def getmdtext(self):
        ''' get all or selected text '''
        if self.txt.tag_ranges("sel"):
            text = self.txt.selection_get()
        else:  # Select All
            self.txt.focus()
            self.txt.tag_add(SEL, '1.0', END)
            self.txt.mark_set(INSERT, '1.0')
            self.txt.see(INSERT)
            if self.txt.tag_ranges("sel"):
                text = self.txt.selection_get()
                self.txt.tag_remove(SEL, "1.0", END)
        return text


    def on_md_open(self, e=None):
        ''' open txt (MD) in your text editor '''
        text = self.getmdtext()
        filename = os.getcwd() + '/' + self.MyFile
        print(filename)
        with open(filename, 'w') as f:
            f.write(text)
        print(filename, self.MyEditor)
        subprocess.Popen([self.MyEditor, filename])


    def on_md_render(self, e=None):
        ''' render txt (MD) to html and show window '''
        text = self.getmdtext()
        # convert MD to HTML
        H = markdown.markdown(text,
                              extensions=['fenced_code'])
        # write to file
        filename = os.getcwd() + '/' + self.MyFile + '.html'
        print(filename)
        with open(filename, 'w') as f:
            f.write(H)
        # open file in browser
        webbrowser.open_new_tab('file:///' + filename)


    def speak_text(self, e=None):
        ''' Speak the query response text '''
        text = self.getmdtext()  # get selected or all text
        self.espeak_proc = subprocess.Popen(["espeak-ng", text])

    def speak_text_cancel(self, e=None):
        ''' cancel the currently speaking text '''
        self.espeak_proc.send_signal(signal.SIGINT)


    def on_kb_help(self, e=None):
        ''' display hot keys message '''
        msg = '''
<Ctrl-t> View response metrics\n
<Ctrl-m> Temporarily Toggle\n
    show-elapsed-time\n
<Ctrl-h> This HotKey help\n
<Ctrl-q> Close Program\n
    No Prompt\n
<Ctrl-s> Save output (Button)\n
<Ctrl-g> Submit Query (Button)\n
<Ctrl-Enter> Submit & Append\n
<Ctrl-Shift-S> Speak the Text\n
<Escape> Cancel Speaking Text\n
        '''
        messagebox.showinfo("Hot Keys Help", msg)


    def do_pop_query(self, event):
        ''' handles right-click for context menu '''
        try:
            self.popup_query.tk_popup(event.x_root,
                                event.y_root, 0)
        except:
            self.popup_query.grab_release()

    def do_pop_txt(self, event):
        ''' handles right-click for context menu '''
        try:
            self.popup_txt.tk_popup(event.x_root,
                                event.y_root, 0)
        except:
            self.popup_txt.grab_release()

    def popquery(self, n):
        ''' Routes query Text context menu actions '''
        if n == 1:  # Copy
            root.clipboard_clear()  # clear clipboard contents
            if self.query.tag_ranges("sel"):
                root.clipboard_append(self.query.selection_get())  # append new value to clipbaord
        elif n == 2:  # Paste
            inx = self.query.index(INSERT)
            try:
                self.query.insert(inx, root.clipboard_get())
            except Exception as e:
                return
        elif n == 3:  # Copy All
            self.query.focus()
            self.query.tag_add(SEL, '1.0', END)
            self.query.mark_set(INSERT, '1.0')
            self.query.see(INSERT)
            root.clipboard_clear()  # clear clipboard contents
            if self.query.tag_ranges("sel"):  # append new value to clipbaord
                root.clipboard_append(self.query.selection_get())
                self.query.tag_remove(SEL, "1.0", END)
        elif n == 4:  # larger
            self.TOPFRAME += 2
            self.query.config(height=self.TOPFRAME)
        elif n == 5:  # smaller
            if self.TOPFRAME > 3:
                self.TOPFRAME -= 2
                self.query.config(height=self.TOPFRAME)
        else:   # 6
            search = self.query.selection_get()
            webbrowser.open("https://duckduckgo.com/?q=" + search)

    def poptxt(self, n):
        ''' Routes txt Text context menu actions '''
        if n == 1:  # Copy
            root.clipboard_clear()  # clear clipboard contents
            root.clipboard_append(self.txt.selection_get())  # append new value to clipbaord
        elif n == 2:  # Paste
            inx = self.txt.index(INSERT)
            self.txt.insert(inx, root.clipboard_get())
        else:  # Select All
            self.txt.focus()
            self.txt.tag_add(SEL, '1.0', END)
            self.txt.mark_set(INSERT, '1.0')
            self.txt.see(INSERT)
            root.clipboard_clear()  # clear clipboard contents
            if self.txt.tag_ranges("sel"):  # append new value to clipbaord
                root.clipboard_append(self.txt.selection_get())
                self.txt.tag_remove(SEL, "1.0", END)

    def exit_program(self, e=None):
        ''' Only exit program without prompt if
            1. Ctrl-q was hit
            OR
            2. Both Text frames are empty '''
        resp = self.txt.get("1.0", END).strip()
        qury = self.query.get("1.0", END).strip()
        if resp == "" and qury == "":
            save_location()
            sys.exit()
        if e is None:  # ctrl-q avoids this message
            if messagebox.askokcancel('GptGUI',
                                      'Did you want to close the app?') is False:
                return
        save_location()

#------------------------------------------------------------

# SAVE GEOMETRY INFO AND EXIT
def save_location(e=None):
    ''' executes at WM_DELETE_WINDOW event - see below
        Also called from self.exit_program.
        Save window geometry before destruction
    '''
    with open("winfo", "w") as fout:
        fout.write(root.geometry())
    root.destroy()

# used for saving queries with date and time
now = datetime.datetime.now()

# get options that go into the window creation and title
config = configparser.ConfigParser()
config.read('gptgui.ini')
MyTheme = config['Main']['theme']
MyModel = config['Main']['engine']
MyTemp = config['Main']['temperature']
MyTokens = config['Main']['tokens']

# define main window
MyTitle = "GptGUI (OpenAI 1.3.3) " + MyModel + " " + str(MyTokens)
root = Window(MyTitle, MyTheme, iconphoto="icon.png")

# change working directory to path for this file
p = os.path.realpath(__file__)
os.chdir(os.path.dirname(p))

# ACCESS GEOMETRY INFO
if os.path.isfile("winfo"):
    with open("winfo") as f:
        lcoor = f.read()
    root.geometry(lcoor.strip())
else:
    root.geometry("675x505") # WxH+left+top

root.protocol("WM_DELETE_WINDOW", save_location)  # TO SAVE GEOMETRY INFO
root.minsize(790, 325)  # width, height
Sizegrip(root).place(rely=1.0, relx=1.0, x=0, y=0, anchor='se')

Application(root)

root.mainloop()