scribe-cli 0.7.2__tar.gz → 0.7.4__tar.gz

{scribe_cli-0.7.2/scribe_cli.egg-info → scribe_cli-0.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.2
+Version: 0.7.4
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI.
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -87,8 +87,8 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default data folder is `$HOME/.local/share/vosk/language-models`.
-This can be modified.
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+the default is left to the `openai-whisper` package and might change in the future).
 
 
 ## Usage
@@ -122,6 +122,9 @@ where `--no-prompt` jumps right to the recording (after the first interruption,
 ### Virtual keyboard (experimental)
 
 By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
+However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
+That can be achieve with the `--keyboard` option.
+
 With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
 
 ```bash
@@ -130,7 +133,20 @@ scribe --keyboard
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)). In my Ubuntu + Wayland system it works in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). Workarounds include using the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart.
+`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+
+#### Use the keyboard in Ubuntu
+
+In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). I am told this is because Chromium runs an X server emulator and so is compatible with the default pynput backend.
+
+One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
+
+Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+```bash
+sudo modprobe uinput
+sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
+```
+You're on the right path :)
 
 ### System try icon (experimental)
 

{scribe_cli-0.7.2 → scribe_cli-0.7.4}/README.md

@@ -29,8 +29,8 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default data folder is `$HOME/.local/share/vosk/language-models`.
-This can be modified.
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+the default is left to the `openai-whisper` package and might change in the future).
 
 
 ## Usage
@@ -64,6 +64,9 @@ where `--no-prompt` jumps right to the recording (after the first interruption,
 ### Virtual keyboard (experimental)
 
 By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
+However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
+That can be achieve with the `--keyboard` option.
+
 With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
 
 ```bash
@@ -72,7 +75,20 @@ scribe --keyboard
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)). In my Ubuntu + Wayland system it works in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). Workarounds include using the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart.
+`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+
+#### Use the keyboard in Ubuntu
+
+In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). I am told this is because Chromium runs an X server emulator and so is compatible with the default pynput backend.
+
+One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
+
+Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+```bash
+sudo modprobe uinput
+sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
+```
+You're on the right path :)
 
 ### System try icon (experimental)
 

{scribe_cli-0.7.2 → scribe_cli-0.7.4}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.2'
-__version_tuple__ = version_tuple = (0, 7, 2)
+__version__ = version = '0.7.4'
+__version_tuple__ = version_tuple = (0, 7, 4)

{scribe_cli-0.7.2 → scribe_cli-0.7.4}/scribe/app.py

@@ -3,7 +3,7 @@ import tomllib
 import argparse
 from scribe.audio import Microphone
 from scribe.util import print_partial, clear_line, prompt_choices, check_dependencies, ansi_link, colored
-from scribe.models import VoskTranscriber, WhisperTranscriber
+from scribe.models import VoskTranscriber, WhisperTranscriber, StopRecording
 
 with open(Path(__file__).parent / "models.toml", "rb") as f:
     language_config_default = tomllib.load(f)
@@ -147,6 +147,7 @@ def get_parser():
     parser.add_argument("--app", action="store_true", help="Start in app mode (relies on pystray)")
 
     parser.add_argument("--samplerate", default=16000, type=int, help=argparse.SUPPRESS)
+    parser.add_argument("--microphone-device", help="The device index of the microphone to use.", type=int)
     parser.add_argument("--keyboard", action="store_true")
     parser.add_argument("--no-clipboard", dest="clipboard", action="store_false")
     parser.add_argument("--latency", default=0, type=float, help="keyboard latency")
@@ -163,36 +164,20 @@ def get_parser():
 
 
 # Commencer l'enregistrement
-def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=0):
+def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=0, **greetings):
 
     if keyboard:
-        try:
-            from scribe.keyboard import type_text
-        except ImportError:
-            keyboard = False
-            print("Keyboard simulation is not available.")
-            return
-
+        from scribe.keyboard import type_text
         print("\nChange focus to target app during transcription.")
 
 
     if clipboard:
-        try:
-            import pyperclip
-        except ImportError:
-            clipboard = False
-            print("Clipboard simulation is not available.")
-            return
-
+        import pyperclip
         print("\nThe full transcription will be copied to clipboard as it becomes available.")
 
 
     fulltext = ""
 
-    greetings = { k: v for k, v in language_config["_meta"].get(transcriber.language, {}).items()
-                if v is not None and k.startswith(("start", "stop"))
-    }
-
     for result in transcriber.start_recording(micro, **greetings):
 
         if result.get('text'):
@@ -212,6 +197,23 @@ def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=
         print("Copied to clipboard.")
 
 
+def interrupt_app_thread(icon):
+    """Thanks Le Chat for this solution: https://stackoverflow.com/a/325528/2192272
+    """
+    import ctypes
+    thread = icon._recording_thread
+    # Raise an exception in the thread using ctypes
+    thread_id = thread.ident
+    if thread_id is not None:
+        res = ctypes.pythonapi.PyThreadState_SetAsyncExc(
+            ctypes.c_long(thread_id),
+            ctypes.py_object(StopRecording)
+        )
+        if res > 1:
+            ctypes.pythonapi.PyThreadState_SetAsyncExc(thread_id, 0)
+            print("Failure to raise exception in thread")
+
+
 def create_app(micro, transcriber, **kwargs):
     import pystray
     from pystray import Menu as pystrayMenu, MenuItem as Item
@@ -219,26 +221,38 @@ def create_app(micro, transcriber, **kwargs):
     import PIL.ImageOps
 
     import scribe_data
+    import threading
 
     # Load an image from a file
     image = Image.open(Path(scribe_data.__file__).parent / "share" / "icon.jpg")
 
     def callback_quit(icon, item):
         icon.visible = False
+        ## Here we need to stop the recording thread
+        callback_stop_recording(icon, item)
         icon.stop()
 
+    def callback_stop_recording(icon, item):
+        ## Here we need to stop the recording thread
+        interrupt_app_thread(icon)
+        icon._recording_thread.join()
+
     def callback_record(icon, item):
-        print(f"Clicked {item}")
-        # icon.icon = PIL.ImageOps.invert(icon.icon)
-        # icon.icon = PIL.ImageOps.invert(image)
-        # icon.update_menu()
-        start_recording(micro, transcriber, **kwargs)
-        # icon.icon = image
-        # icon.update_menu()
+        icon._recording_thread = threading.Thread(target=start_recording, args=(micro, transcriber), kwargs=kwargs)
+        icon._recording_thread.start()
+
+    def is_recording(item):
+        return hasattr(icon, "_recording_thread") and icon._recording_thread.is_alive()
+
+    def is_not_recording(item):
+        return not is_recording(item)
+
 
     # Create a menu
     menu = pystrayMenu(
-        Item('Record', callback_record),
+        # Item('Record', callback_record),
+        Item("Record", callback_record, visible=is_not_recording),
+        Item("Stop", callback_stop_recording, visible=is_recording),
         Item('Quit', callback_quit),
     )
 
@@ -255,7 +269,7 @@ def main(args=None):
 
 
     # Set up the microphone for recording
-    micro = Microphone(samplerate=o.samplerate)
+    micro = Microphone(samplerate=o.samplerate, device=o.microphone_device)
 
     transcriber = None
 
@@ -312,11 +326,17 @@ def main(args=None):
                 continue
 
         if o.app:
-            app = create_app(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency)
+            greetings = dict(
+                start_message = "Listening... Use the try icon menu to stop.",
+            )
+            app = create_app(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency, **greetings)
             print("Starting app...")
             app.run()
         else:
-            start_recording(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency)
+            greetings = dict(
+                start_message = "Listening... Press Ctrl+C to stop.",
+            )
+            start_recording(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency, **greetings)
 
         # if we arrived so far, that means we pressed Ctrl + C anyway, and need Enter to move on.
         # So we leave the wider range of options to change the model.

scribe_cli-0.7.4/scribe/keyboard.py

@@ -0,0 +1,51 @@
+"""This module handles typing characters as if they were typed on a keyboard.
+"""
+import platform
+import time
+
+try:
+    # import pyautogui
+    from pynput.keyboard import Controller, Key
+
+except ImportError:
+    print("Please install pynput to use the keyboard feature.")
+    raise
+
+# Create a keyboard controller
+keyboard = Controller()
+
+def paste_text():
+    """This does not work with the uinput backend
+    """
+    os_name = platform.system()
+
+    if os_name == "Darwin":  # macOS
+        with keyboard.pressed(Key.cmd):
+            keyboard.press('v')
+            keyboard.release('v')
+
+    else:  # Windows and Linux
+        keyboard.press(Key.ctrl)
+        keyboard.press('v')
+        keyboard.release('v')
+        keyboard.release(Key.ctrl)
+
+def type_text(text, interval=0, paste=False):
+    # Simulate typing a string
+    # import subprocess
+    # subprocess.run(["ydotool", "type", text])
+
+    if paste:
+        import pyperclip
+        keep_state = pyperclip.paste()
+        pyperclip.copy(text)
+        paste_text()
+        pyperclip.copy(keep_state)
+        return
+
+    if interval > 0:
+        for c in text:
+            keyboard.type(c)
+            time.sleep(interval)
+    else:
+        keyboard.type(text)

{scribe_cli-0.7.2 → scribe_cli-0.7.4}/scribe/models.py

@@ -12,9 +12,12 @@ def is_silent(data, silence_thresh=-40):
     """
     return calculate_decibels(data) < silence_thresh
 
-VOSK_MODELS_FOLDER = os.path.join(os.environ.get("HOME"),
-                                      ".local/share/vosk/language-models")
+HOME = os.environ.get('HOME', os.path.expanduser('~'))
+XDG_CACHE_HOME = os.environ.get('XDG_CACHE_HOME', os.path.join(HOME, '.cache'))
+VOSK_MODELS_FOLDER = os.path.join(XDG_CACHE_HOME, "vosk")
 
+class StopRecording(Exception):
+    pass
 
 class AbstractTranscriber:
     backend = None
@@ -85,7 +88,7 @@ class AbstractTranscriber:
                         if self.is_overtime():
                             raise KeyboardInterrupt("Overtime: {:.2f} seconds".format(self.get_elapsed()))
 
-        except KeyboardInterrupt:
+        except (KeyboardInterrupt, StopRecording):
             pass
 
         finally:

scribe_cli-0.7.4/scribe/models.toml

@@ -0,0 +1,23 @@
+[vosk.en]
+model = "vosk-model-en-us-0.42-gigaspeech"
+
+[vosk.fr]
+model = "vosk-model-fr-0.22"
+
+[vosk.de]
+model = "vosk-model-de-tuda-0.6-900k"
+
+[vosk.it]
+model = "vosk-model-it-0.22"
+
+[_meta.en]
+language = "English (US)"
+
+[_meta.fr]
+language = "French"
+
+[_meta.de]
+language = "German"
+
+[_meta.it]
+language = "Italian"

{scribe_cli-0.7.2 → scribe_cli-0.7.4/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.2
+Version: 0.7.4
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI.
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -87,8 +87,8 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default data folder is `$HOME/.local/share/vosk/language-models`.
-This can be modified.
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+the default is left to the `openai-whisper` package and might change in the future).
 
 
 ## Usage
@@ -122,6 +122,9 @@ where `--no-prompt` jumps right to the recording (after the first interruption,
 ### Virtual keyboard (experimental)
 
 By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
+However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
+That can be achieve with the `--keyboard` option.
+
 With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
 
 ```bash
@@ -130,7 +133,20 @@ scribe --keyboard
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)). In my Ubuntu + Wayland system it works in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). Workarounds include using the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart.
+`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+
+#### Use the keyboard in Ubuntu
+
+In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in chromium based applications (including vscode) but it does not in firefox and sublime text and any of the rest (not even in a terminal !). I am told this is because Chromium runs an X server emulator and so is compatible with the default pynput backend.
+
+One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
+
+Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+```bash
+sudo modprobe uinput
+sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
+```
+You're on the right path :)
 
 ### System try icon (experimental)
 

scribe_cli-0.7.2/scribe/keyboard.py

@@ -1,18 +0,0 @@
-"""This module handles typing characters as if they were typed on a keyboard.
-"""
-try:
-    # import pyautogui
-    from pynput.keyboard import Controller
-
-except ImportError:
-    print("Please install pynput to use the keyboard feature.")
-    raise
-
-# Create a keyboard controller
-keyboard = Controller()
-
-def type_text(text, interval=0):
-    # Simulate typing a string
-    # import subprocess
-    # subprocess.run(["ydotool", "type", text])
-    keyboard.type(text)

scribe_cli-0.7.2/scribe/models.toml

@@ -1,31 +0,0 @@
-[vosk.en]
-model = "vosk-model-en-us-0.42-gigaspeech"
-
-[vosk.fr]
-model = "vosk-model-fr-0.22"
-
-[vosk.de]
-model = "vosk-model-de-tuda-0.6-900k"
-
-[vosk.it]
-model = "vosk-model-it-0.22"
-
-[_meta.en]
-language = "English (US)"
-start_message = "Listening... Press Ctrl+C to stop."
-stop_message = "Recording stopped."
-
-[_meta.fr]
-language = "French"
-start_message = "En écoute... Appuyez sur Ctrl+C pour arrêter."
-stop_message = "Écoute arrêtée."
-
-[_meta.de]
-language = "German"
-start_message = "Hören... Drücken Sie Strg+C, um zu stoppen."
-stop_message = "Aufnahme gestoppt."
-
-[_meta.it]
-language = "Italian"
-start_message = "In ascolto... Premere Ctrl+C per interrompere."
-stop_message = "Registrazione interrotta."