scribe-cli 0.11.0__tar.gz → 0.12.0__tar.gz

{scribe_cli-0.11.0/scribe_cli.egg-info → scribe_cli-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.11.0
+Version: 0.12.0
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI, with the goal of serving as a virtual keyboard on a computer
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -158,7 +158,7 @@ The content of the (full) transcription is then pasted to the clipboard, and it
 Alternatively an output file can be indicated:
 
 ```bash
- --keyboard -o transcription.txt
+scribe -o transcription.txt
 ```
 
 ### Virtual keyboard (experimental)
@@ -196,8 +196,8 @@ To activate start with:
 scribe --app
 ```
 or toggle the app option in the interactive menu. The scribe icon will show, with Record and other options. The icon will change based on what the app is doing. It is possible to choose from a set
-of predefined models, or to Quit and choose from the terminal before pressing Enter again.
-For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording, transcribing and idle/waiting.
+of predefined models (controlled by `--vosk-models` and `whisper-models`) and options, or to Quit and choose from the terminal before pressing Enter again.
+For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording/waiting, transcribing and idle.
 That option requires `pystray` to be installed. This is included with the `pip install ...[all]` option. In Ubuntu the following dependencies were required to make the menus appear:
 
 ```bash
@@ -205,6 +205,8 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
+<img src=https://github.com/user-attachments/assets/4c97f4b1-1a65-4d49-9f5a-a9f4287cfa5a width=300px>
+
 ## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
@@ -218,13 +220,10 @@ scribe-install --clipboard  --api YOUROPENAIAPIKEY
 ```
 (`--api` is optional and only useful if you plan to use `openaiapi` backend later on)
 
-And to make an app running outside the terminal:
-
+It is also possible to run an app fully outside the terminal:
 ```bash
-scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal  --api YOUROPENAIAPIKEY
+scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal --restart-after-silence --api YOUROPENAIAPIKEY  --vosk-models vosk-model-fr-0.22 --whisper-models small turbo
 ```
-This will install two separate apps (names "Scribe" and "Scribe App")
-
 
 ## Fine tuning
 

{scribe_cli-0.11.0 → scribe_cli-0.12.0}/README.md

@@ -90,7 +90,7 @@ The content of the (full) transcription is then pasted to the clipboard, and it
 Alternatively an output file can be indicated:
 
 ```bash
- --keyboard -o transcription.txt
+scribe -o transcription.txt
 ```
 
 ### Virtual keyboard (experimental)
@@ -128,8 +128,8 @@ To activate start with:
 scribe --app
 ```
 or toggle the app option in the interactive menu. The scribe icon will show, with Record and other options. The icon will change based on what the app is doing. It is possible to choose from a set
-of predefined models, or to Quit and choose from the terminal before pressing Enter again.
-For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording, transcribing and idle/waiting.
+of predefined models (controlled by `--vosk-models` and `whisper-models`) and options, or to Quit and choose from the terminal before pressing Enter again.
+For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording/waiting, transcribing and idle.
 That option requires `pystray` to be installed. This is included with the `pip install ...[all]` option. In Ubuntu the following dependencies were required to make the menus appear:
 
 ```bash
@@ -137,6 +137,8 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
+<img src=https://github.com/user-attachments/assets/4c97f4b1-1a65-4d49-9f5a-a9f4287cfa5a width=300px>
+
 ## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
@@ -150,13 +152,10 @@ scribe-install --clipboard  --api YOUROPENAIAPIKEY
 ```
 (`--api` is optional and only useful if you plan to use `openaiapi` backend later on)
 
-And to make an app running outside the terminal:
-
+It is also possible to run an app fully outside the terminal:
 ```bash
-scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal  --api YOUROPENAIAPIKEY
+scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal --restart-after-silence --api YOUROPENAIAPIKEY  --vosk-models vosk-model-fr-0.22 --whisper-models small turbo
 ```
-This will install two separate apps (names "Scribe" and "Scribe App")
-
 
 ## Fine tuning
 
@@ -165,4 +164,4 @@ Best is to check the available options in the online help:
 
 ```bash
 scribe --help
-```
+```

{scribe_cli-0.11.0 → scribe_cli-0.12.0}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.11.0'
-__version_tuple__ = version_tuple = (0, 11, 0)
+__version__ = version = '0.12.0'
+__version_tuple__ = version_tuple = (0, 12, 0)

{scribe_cli-0.11.0 → scribe_cli-0.12.0}/scribe/app.py

@@ -204,13 +204,17 @@ def get_parser():
     group.add_argument("--silence", default=2, type=float, help="silence duration (default %(default)s s)")
     group.add_argument("--silence-db", default=-30, type=float, help="silence magnitude in decibel (default %(default)s db)")
     group.add_argument("-a", "--restart-after-silence", action="store_true", help="Restart the recording after a transcription triggered by a silence")
+    group.add_argument("--download-folder-whisper", help="Folder to store Whisper models.")
 
     group = parser.add_argument_group("whisper api")
     group.add_argument("--api-key",
                         help="API key for the Whisper API backend.")
 
+    group = parser.add_argument_group("App")
+    group.add_argument("--vosk-models", nargs="*", help="vosk models available for the app mode", default=vosk_models)
+    group.add_argument("--whisper-models", nargs="*", help="whisper models available for the app mode", default=whisper_models)
+
     parser.add_argument("--download-folder-vosk", help="Folder to store Vosk models.")
-    parser.add_argument("--download-folder-whisper", help="Folder to store Whisper models.")
 
     return parser
 
@@ -272,15 +276,7 @@ def create_app(micro, transcriber, other_transcribers=None, **kwargs):
 
     def update_icon(icon, force=False):
         transcriber = icon._transcriber
-        if transcriber.recording and transcriber.waiting:
-            # this is the situation with the whisper backend when the microphone is recording
-            # but we wait for the speaker to speak (silence)
-            if force or getattr(icon, "_icon_label", None) != None:
-                icon.icon = image
-                icon._icon_label = None
-                icon.update_menu()
-
-        elif transcriber.recording:
+        if transcriber.recording:
             if force or getattr(icon, "_icon_label", None) != "recording":
                 icon.icon = image_recording
                 icon._icon_label = "recording"
@@ -326,8 +322,8 @@ def create_app(micro, transcriber, other_transcribers=None, **kwargs):
     def callback_record(icon, item):
         transcriber = icon._transcriber
         if transcriber.busy:
-            transcriber.log("Still busy recording or transcribing.")
-            return
+            # transcriber.log("Still busy recording or transcribing.")
+            return callback_stop_recording(icon, item)  # play / stop behavior
 
         if hasattr(icon, "_recording_thread") and icon._recording_thread.is_alive():
             icon._recording_thread.join()
@@ -357,18 +353,10 @@ def create_app(micro, transcriber, other_transcribers=None, **kwargs):
         # icon.menu.items[0].__name__ = f"Record [{str(item)}]"
         icon._model_selection = False
         icon.update_menu()
-        icon.notify(f"Set {transcriber.backend} {transcriber.model_name}")
-
-    def callback_info(icon, item):
-        transcriber = icon._transcriber
-        # icon.notify(f"scribe {transcriber.backend} {transcriber.model_name}")
-        title = f"""{transcriber.backend} :: {transcriber.model_name}"""
-        info = [name for name in kwargs if isinstance(kwargs[name], bool) and kwargs[name]]
-        icon.notify(" | ".join(info), title=title)
 
     def callback_toggle_option(icon, item):
+        callback_stop_recording(icon, item)
         kwargs[str(item)] = not kwargs[str(item)]
-        callback_info(icon, item)
 
     def is_model_selection(item):
         return icon._model_selection
@@ -379,19 +367,24 @@ def create_app(micro, transcriber, other_transcribers=None, **kwargs):
     def is_not_recording(item):
         return not is_recording(item) and not is_model_selection(item)
 
+    def is_checked(item):
+        return icon._transcriber.model_name == str(item)
+
+    def is_checked_option(item):
+        return kwargs[str(item)]
+
     modeltitle = f"{transcriber.backend} :: {transcriber.model_name}"
     title = f"scribe :: {modeltitle}"
 
     menus = []
-    menus.append(Item(f"Record" if len(other_transcribers_dict) <= 1 else f"Record", callback_record, visible=is_not_recording))
+    menus.append(Item(f"Record", callback_record, visible=is_not_recording, default=True))
     menus.append(Item("Stop", callback_stop_recording, visible=is_recording))
     menus.append(Item("Choose Model", pystrayMenu(
-        *(Item(f"{name}", callback_set_model) for name in other_transcribers_dict)))
+        *(Item(f"{name}", callback_set_model, checked=is_checked) for name in other_transcribers_dict)))
     )
     menus.append(Item("Toggle Options", pystrayMenu(
-        *(Item(f"{name}", callback_toggle_option) for name in kwargs if isinstance(kwargs[name], bool))))
+        *(Item(f"{name}", callback_toggle_option, checked=is_checked_option) for name in kwargs if isinstance(kwargs[name], bool))))
     )
-    menus.append(Item(f"Info", callback_info))
     menus.append(Item('Quit', callback_quit))
 
     # Create a menu
@@ -537,8 +530,8 @@ def main(args=None):
 
             app = create_app(micro, transcriber, other_transcribers=[
                 {**vars(o), "backend": "openaiapi", "model": "whisper-1"},
-                *[{**vars(o), "backend": "whisper", "model": model} for model in whisper_models],
-                *[{**vars(o), "backend": "vosk", "model": model} for model in vosk_models]],
+                *[{**vars(o), "backend": "whisper", "model": model} for model in o.whisper_models],
+                *[{**vars(o), "backend": "vosk", "model": model} for model in o.vosk_models]],
                              clipboard=o.clipboard, output_file=o.output_file,
                              keyboard=o.keyboard, latency=o.latency, ascii=o.ascii, **greetings)
             print("Starting app...")

{scribe_cli-0.11.0 → scribe_cli-0.12.0/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.11.0
+Version: 0.12.0
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI, with the goal of serving as a virtual keyboard on a computer
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -158,7 +158,7 @@ The content of the (full) transcription is then pasted to the clipboard, and it
 Alternatively an output file can be indicated:
 
 ```bash
- --keyboard -o transcription.txt
+scribe -o transcription.txt
 ```
 
 ### Virtual keyboard (experimental)
@@ -196,8 +196,8 @@ To activate start with:
 scribe --app
 ```
 or toggle the app option in the interactive menu. The scribe icon will show, with Record and other options. The icon will change based on what the app is doing. It is possible to choose from a set
-of predefined models, or to Quit and choose from the terminal before pressing Enter again.
-For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording, transcribing and idle/waiting.
+of predefined models (controlled by `--vosk-models` and `whisper-models`) and options, or to Quit and choose from the terminal before pressing Enter again.
+For the vosk model, there are only two states : recording + transcribing or Idle. For the whisper model there are three states visible from the icon: recording/waiting, transcribing and idle.
 That option requires `pystray` to be installed. This is included with the `pip install ...[all]` option. In Ubuntu the following dependencies were required to make the menus appear:
 
 ```bash
@@ -205,6 +205,8 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
+<img src=https://github.com/user-attachments/assets/4c97f4b1-1a65-4d49-9f5a-a9f4287cfa5a width=300px>
+
 ## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
@@ -218,13 +220,10 @@ scribe-install --clipboard  --api YOUROPENAIAPIKEY
 ```
 (`--api` is optional and only useful if you plan to use `openaiapi` backend later on)
 
-And to make an app running outside the terminal:
-
+It is also possible to run an app fully outside the terminal:
 ```bash
-scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal  --api YOUROPENAIAPIKEY
+scribe-install --backend openaiapi --name "Scribe App" --keyboard --clipboard --app --no-prompt --no-terminal --restart-after-silence --api YOUROPENAIAPIKEY  --vosk-models vosk-model-fr-0.22 --whisper-models small turbo
 ```
-This will install two separate apps (names "Scribe" and "Scribe App")
-
 
 ## Fine tuning