https://github.com/MLeidel/GptGUI-2
A simple desktop application to access general OpenAI Gpt engine
https://github.com/MLeidel/GptGUI-2
ai gpt-3 gpt-4 openai python ttkbootstrap
Last synced: 5 months ago
JSON representation
A simple desktop application to access general OpenAI Gpt engine
- Host: GitHub
- URL: https://github.com/MLeidel/GptGUI-2
- Owner: MLeidel
- License: unlicense
- Created: 2023-01-18T22:20:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-16T02:17:46.000Z (5 months ago)
- Last Synced: 2025-08-16T02:29:34.919Z (5 months ago)
- Topics: ai, gpt-3, gpt-4, openai, python, ttkbootstrap
- Language: Python
- Homepage: https://mleidel.github.io/GptGUI/
- Size: 8.08 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GptGUI-2
### Python GUI to access Gpt Engine with OpenAI
- Temporary Chat Mode
- Supports a variety of OpenAI models
- Choose from many themes
- Convert responses to HTML or VOICE
- Maintains a log of reponses
see https://platform.openai.com/docs for model information
_make sure to pip install the latest **openai** module_
----
## Instalation
For Linux / Mac you can either _gh repo clone MLeidel/GptGUI_ or download a zip
file of this repo.
Before using this application Python 3.x must be installed.
To install Python go to https://www.python.org/downloads/.
Click __Download Python__ and follow the installation instructions.
`tkinter` is automatically installed with Python on Windows
For Linux tkinter is installed with: `apt install python3-tk`
Use the requirements.txt file to install any modules you may be missing.
```bash
pip3 install -r requirements.txt
```
**Voice**
For voice playback of the responses the `mpv` vidio player is required for Linux.
For voice playback on Windows OS no player is required but VLC is recommended.
___
You will also have to Sign Up at https://openai.com/api/ and __create
an API Key__.
There is no cost to do so.
You should configure your key with an Environment Variable and use that
Variable name in the options.
___
After starting the app the first time click the _Options_
button. Change any other options that would work better on your system or preferences.
## Options
The options are stored in a plain text file called _gptgui.ini_.
If you prefer you could change the settings with a text editor.
---
## Buttons
Type your prompt in the top box, and hit __"Submit Query"__ or _Ctrl-g_.
The Gpt AI response will appear in the larger box below.
- **New**
> Begins a new conversation
- **View**
> Displays the log file you set up in Options
- **Purge**
> Clears the contens of the log file
- **Text**
> Opens the current response or selection in your text editor
Set up the name of your text editor in the options.
- **Html**
> Opens the current response or selection in your default browser
Converting Markdown to HTML
- **Options**
> launches the Options editor program
- **Submit Query**
> Submits prompt to OpenAI engine
- **Close**
> Exit the program. _Ctrl-q_ exits the program quickly.
---
## Context menu
There is a context (Right-Click) menu for convenience.
The height of the query text area (top frame) can be lengthened
or shortened with this menu.
---
## Operation
At startup, if a previous conversation is detected the user is prompted
to either continue or start a new conversation. So closing the app does
not terminate a conversation. Also, to start a new conversatioin while
the app is running use the 'New' button. Multiple conversations are not
preserved anywhere, but will remain in the log until it is purged.
GptGUI operates with other software on your system:
text editor
audio players
Internet browser
Python/tkinter and libraries
## Hot Keys
| key | action |
| :--- | :--- |
|__Ctrl-H__| This HotKey help|
|__Ctrl-Q__| Close Program No Prompt|
|__Ctrl-Shift-S__| Speak the Currrent Text|
|__Ctrl-Shift_T__| Toggle Speech|
|__Ctrl-G__| Submit Query (Button)|
|__Ctrl-Enter__ | same as Ctrl-g|
|__Ctrl-F__| Find text |
|__Ctrl-N__| Find next text |
----
END