Complete rework for GUI, experimental EXE file and other minor change…

…s, see readme for more info

CITATION.cff

@@ -4,8 +4,8 @@ authors:
 - family-names: "Söderström"
   given-names: "Kristofer Rolf"
   orcid: "https://orcid.org/0000-0002-5322-3350"
-title: "transcribe"
-version: 1.1.1
-doi: 10.5281/zenodo.7760511
+title: "Local Transcribe"
+version: 1.2
+doi: 10.5281/zenodo.7760510
 date-released: 2023-03-22
 url: "https://github.com/soderstromkr/transcribe"

Mac_instructions.md

@@ -0,0 +1,9 @@
+### How to run on Mac
+Unfortunately, I have not found a permament solution for this, not being a Mac user has limited the ways I can test this.  
+#### Recommended steps
+1. Open a terminal and navigate to the root folder (the downloaded the folder). 
+    1. You can also right-click (or equivalent) on the root folder to open a Terminal within the folder.
+2. Run the following command:
+```
+python main.py
+```

README.md

@@ -1,71 +1,75 @@
-## Local Transcribe
-
-Local Transcribe uses OpenAI's Whisper to transcribe audio files from your local folders, creating text files on disk. 
-
-## Note
-
-This implementation and guide is mostly made for researchers not familiar with programming that want a way to transcribe their files locally, without internet connection, usually required within ethical data practices and frameworks. Two examples are shown, a normal workflow with internet connection. And one in which the model is loaded first, via openai-whisper, and then the transcription can be done without being connected to the internet. There is now also a GUI implementation, read below for more information.  
-
-### Instructions
-
-#### Requirements
-
+## Local Transcribe with Whisper 
+Local Transcribe with Whisper is a user-friendly desktop application that allows you to transcribe audio and video files using the Whisper ASR system. This application provides a graphical user interface (GUI) built with Python and the Tkinter library, making it easy to use even for those not familiar with programming.
+
+## New in version 1.2!
+1. Simpler usage:
+    1. File type: You no longer need to specify file type. The program will only transcribe elligible files.
+    2. Language: Added option to specify language, which might help in some cases. Clear the default text to run automatic language recognition.
+    3. Model selection: Now a dropdown option that includes most models for typical use. 
+2. New and improved GUI.
+![python GUI.py](images/gui-windows.png)
+3. Executable: On Windows and don't want to install python? Try the Exe file! See below for instructions (Experimental)
+
+## Features
+* Select the folder containing the audio or video files you want to transcribe. Tested with m4a video. 
+* Choose the language of the files you are transcribing. You can either select a specific language or let the application automatically detect the language.
+* Select the Whisper model to use for the transcription. Available models include "base.en", "base", "small.en", "small", "medium.en", "medium", and "large". Models with .en ending are better if you're transcribing English, especially the base and small models.
+* Enable the verbose mode to receive detailed information during the transcription process.
+* Monitor the progress of the transcription with the progress bar and terminal. 
+* Confirmation dialog before starting the transcription to ensure you have selected the correct folder.
+* View the transcribed text in a message box once the transcription is completed.
+
+## Installation
+### Get the files
+Download the zip folder and extract it to your preferred working folder.
+![](Picture1.png)  
+Or by cloning the repository with:
+```
+git clone https://github.com/soderstromkr/transcribe.git
+```
+### Executable Version **(Experimental. Windows only)**
+The executable version of Local Transcribe with Whisper is a standalone program and should work out of the box. This experimental version is available if you have Windows, and do not have (or don't want to install) python and additional dependencies. However, it requires more disk space (around 1Gb), has no GPU acceleration and has only been lightly tested for bugs, etc. Let me know if you run into any issues! 
+1. Download the project folder. As the image above shows.
+2. Navigate to build.
+3. Unzip the folder (get a coffee or a tea, this might take a while depending on your computer)
+3. Run the executable (app.exe) file.
+### Python Version **(any platform including Mac users)**
+This is recommended if you don't have Windows. Have Windows and use python, or want to use GPU acceleration (Pytorch and Cuda) for faster transcriptions. I would generally recommend this method anyway, but I can understand not everyone wants to go through the installation process for Python, Anaconda and the other required packages. 
 1. This script was made and tested in an Anaconda environment with Python 3.10. I recommend this method if you're not familiar with Python.
 See [here](https://docs.anaconda.com/anaconda/install/index.html) for instructions. You might need administrator rights. 
-
 2. Whisper requires some additional libraries. The [setup](https://github.com/openai/whisper#setup) page states: "The codebase also depends on a few Python packages, most notably HuggingFace Transformers for their fast tokenizer implementation and ffmpeg-python for reading audio files."
 Users might not need to specifically install Transfomers. However, a conda installation might be needed for ffmpeg[^1], which takes care of setting up PATH variables. From the anaconda prompt, type or copy the following:
-
 ```
 conda install -c conda-forge ffmpeg-python
 ```
-
 3. The main functionality comes from openai-whisper. See their [page](https://github.com/openai/whisper) for details. As of 2023-03-22 you can install via:
-
 ```
 pip install -U openai-whisper
 ```
-
-4. There is an option to run a batch file, which launches a GUI built on TKinter and TTKthemes. If using these options, make sure they are installed in your Python build. You can install them via pip.
-
+4. To run the app built on TKinter and TTKthemes. If using these options, make sure they are installed in your Python build. You can install them via pip.
 ```
-pip install tk
+pip install tkinter
 ```
-
 and
-
 ```
-pip install ttkthemes 
+pip install customtkinter 
 ```
-
-#### Using the script
-
-This is a simple script with no installation. You can download the zip folder and extract it to your preferred working folder.
-
-![](Picture1.png)  
-
-Or by cloning the repository with:
-
-```
-git clone https://github.com/soderstromkr/transcribe.git
-```
-
-
-#### Example with Jupyter Notebook
-
-See [example](example.ipynb) for an implementation on Jupyter Notebook, also added an example for a simple [workaround](example_no_internet.ipynb) to transcribe while offline.
-
-#### Using the GUI
-
-You can also run the GUI version from your terminal running ```python GUI.py``` or with the batch file called run_Windows.bat (for Windows users), just make sure to add your conda path to it. If you want to download a model first, and then go offline for transcription, I recommend running the model with the default sample folder, which will download the model locally. 
-
-The GUI should look like this:
-
-![python GUI.py](gui_jpeg.jpg?raw=true)
-
-or this, on a Mac, by running `python GUI.py` or `python3 GUI.py`:
-
-![python GUI Mac.py](gui-mac.png)
+5. Run the app: 
+    1. For **Windows**: In the same folder as the *app.py* file, run the app from terminal by running ```python app.py``` or with the batch file called run_Windows.bat (for Windows users), which assumes you have conda installed and in the base environment (This is for simplicity, but users are usually adviced to create an environment, see [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands) for more info) just make sure you have the correct environment (right click on the file and press edit to make any changes). If you want to download a model first, and then go offline for transcription, I recommend running the model with the default sample folder, which will download the model locally. 
+    2. For **Mac**: Haven't figured out a better way to do this, see [the instructions here](Mac_instructions.txt)
+## Usage
+1. When launched, the app will also open a terminal that shows some additional information.
+2. Select the folder containing the audio or video files you want to transcribe by clicking the "Browse" button next to the "Folder" label. This will open a file dialog where you can navigate to the desired folder. Remember, you won't be choosing individual files but whole folders!
+3. Enter the desired language for the transcription in the "Language" field. You can either select a language or leave it blank to enable automatic language detection.
+4. Choose the Whisper model to use for the transcription from the dropdown list next to the "Model" label.
+5. Enable the verbose mode by checking the "Verbose" checkbox if you want to receive detailed information during the transcription process.
+6. Click the "Transcribe" button to start the transcription. The button will be disabled during the process to prevent multiple transcriptions at once.
+7. Monitor the progress of the transcription with the progress bar.
+8. Once the transcription is completed, a message box will appear displaying the transcribed text. Click "OK" to close the message box.
+9. You can run the application again or quit the application at any time by clicking the "Quit" button.
+
+## Jupyter Notebook
+Don't want fancy EXEs or GUIs? Use the function as is. See [example](example.ipynb) for an implementation on Jupyter Notebook.
 
 [^1]: Advanced users can use ```pip install ffmpeg-python``` but be ready to deal with some [PATH issues](https://stackoverflow.com/questions/65836756/python-ffmpeg-wont-accept-path-why), which I encountered in Windows 11.