Update and rename Mac_2_instructions.txt to Mac_instructions.txt

CITATION.cff

@@ -5,7 +5,7 @@ authors:
   given-names: "Kristofer Rolf"
   orcid: "https://orcid.org/0000-0002-5322-3350"
 title: "transcribe"
-version: 1.0
+version: 1.1.1
 doi: 10.5281/zenodo.7760511
 date-released: 2023-03-22
 url: "https://github.com/soderstromkr/transcribe"

GUI.py

@@ -14,11 +14,12 @@ class App:
         self.master = master
         master.title("Local Transcribe")
 
-        #style = ttk.Style()
+        #style options
-        #style.configure('TLabel', font=('Arial', 10), padding=10)
+        style = ttk.Style()
-        #style.configure('TEntry', font=('Arial', 10), padding=10)
+        style.configure('TLabel', font=('Arial', 10), padding=10)
-        #style.configure('TButton', font=('Arial', 10), padding=10)
+        style.configure('TEntry', font=('Arial', 10), padding=10)
-        #style.configure('TCheckbutton', font=('Arial', 10), padding=10)
+        style.configure('TButton', font=('Arial', 10), padding=10)
+        style.configure('TCheckbutton', font=('Arial', 10), padding=10)
 
         # Folder Path
         path_frame = ttk.Frame(master, padding=10)
@@ -95,6 +96,5 @@ class App:
 if __name__ == "__main__":
 #    root = tk.Tk()
     root = ThemedTk(theme="clearlooks")
-    root.geometry("300x200")
     app = App(root) 
     root.mainloop()

Mac_instructions.txt

@@ -0,0 +1,5 @@
+### 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. For now, these are the recommended steps for a beginner user:
+1. Open a terminal and navigate to the root folder (transcribe-main if you downloaded the folder). You can also right-click (or equivalent) on the root folder to open a Terminal within the folder.
+2. Run the following command: 
+```python GUI.py```

README.md

@@ -1,7 +1,7 @@
 ## transcribe
 Simple script that uses OpenAI's Whisper to transcribe audio files from your local folders. 
 ## 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 interent 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. 
+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
@@ -16,15 +16,27 @@ Users might not need to specifically install Transfomers. However, a conda insta
 ```
 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.
+```
+pip install tk
+```
+and
+```
+pip install ttkthemes 
+```
 #### Using the script
 This is a simple script with no installation. You can either clone the repository with
 ```
 git clone https://github.com/soderstromkr/transcribe.git
 ```
-and use the example.ipynb template to use the script **OR (for beginners)** download the ```transcribe.py``` file into your work folder. Then you can either import it to another script or notebook for use. I recommend jupyter notebook for new users, see the example below. (Remember to have transcribe.py and example.ipynb in the same working folder).
+and use the example.ipynb template to use the script.
-
+**OR** download the ```transcribe.py``` file into your work folder. Then you can either import it to another script or notebook for use. I recommend jupyter notebook for new users, see the example below. (Remember to have transcribe.py and example.ipynb in the same working folder). 
-### Example
+#### 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_gui.bat, 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)
+
 
 [^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.
 

run_Windows.bat

@@ -0,0 +1,5 @@
+@echo off
+echo Starting...
+call conda activate venv
+REM OPTION 2 : (KEEP TEXT WITHIN QUOTES AND CHANGE USERNAME) "C:/Users/user/Anaconda3/condabin/activate.bat"
+call python GUI.py

run_gui.bat

@@ -1,5 +0,0 @@
-@echo off
-call 'PATH_TO_CONDA' 
-call 'ACTIVATE_NEEDED_ENVS'
-call python GUI.py
-PAUSE

sample_audio/transcriptions/Armstrong_Small_Step.txt

@@ -1,3 +1,5 @@
 Armstrong_Small_Step
 In seconds:
-[0.00 --> 24.00]: That's one small step for man, one giant leap for mankind.
+[0.00 --> 7.00]: I'm going to step off the limb now.
+[7.00 --> 18.00]: That's one small step for man.
+[18.00 --> 24.00]: One giant leap for mankind.

sample_audio/transcriptions/Axel_Pettersson_röstinspelning.txt

@@ -1,3 +1,4 @@
 Axel_Pettersson_röstinspelning
 In seconds:
-[0.00 --> 16.00]: Hej, jag heter Axel Pettersson, jag föddes i Örebro 1976. Jag har varit Wikipedia sen 2008 och jag har översatt röstintroduktionsprojektet till svenska.
+[0.00 --> 6.14]: Hej, jag heter Axel Pettersson. Jag följer bror 1976.
+[6.40 --> 15.10]: Jag har varit vikerpedjan sen 2008 och jag har översatt röstintroduktionsprojektet till svenska.

transcribe.py

@@ -1,7 +1,7 @@
 import whisper 
 import glob, os
 
-def transcribe(path, file_type, model=None, language=None, verbose=True):
+def transcribe(path, file_type, model=None, language=None, verbose=False):
     '''Implementation of OpenAI's whisper model. Downloads model, transcribes audio files in a folder and returns the text files with transcriptions'''
 
     try:
@@ -11,10 +11,10 @@ def transcribe(path, file_type, model=None, language=None, verbose=True):
     
     glob_file = glob.glob(path+'/*{}'.format(file_type))
         
-    print('Using {} model, you can change this by specifying model="medium" for example'.format(model))
+    print('Using {} model'.format(model))
-    print('Only looking for file type {}, you can change this by specifying file_type="mp3"'.format(file_type))    
+    print('File type is {}'.format(file_type))    
-    print('Expecting {} language, you can change this by specifying language="English". None will try to auto-detect'.format(language))
+    print('Language is being detected automatically for each file')
-    print('Verbosity is {}. If TRUE it will print out the text as it is transcribed, you can turn this off by setting verbose=False'.format(verbose))
+    print('Verbosity is set to {}'.format(verbose))
     print('\nThere are {} {} files in path: {}\n\n'.format(len(glob_file), file_type, path))
     
     print('Loading model...')
@@ -28,7 +28,7 @@ def transcribe(path, file_type, model=None, language=None, verbose=True):
         result = model.transcribe(
             file, 
             language=language, 
-            verbose=True
+            verbose=verbose
         )
         start=[]
         end=[]