scribe-cli 0.8.0__tar.gz → 0.9.0__tar.gz

{scribe_cli-0.8.0/scribe_cli.egg-info → scribe_cli-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.8.0
+Version: 0.9.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
@@ -201,15 +201,20 @@ pip install PyGObject
 ## 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`
-to make it available from the quick launch menu. Any option will be passed on to `scribe`.
+to make it available from the quick launch menu. Any option will be passed on to `scribe`, with the additional options `--name` and `--no-terminal`.
+`--no-terminal` means no terminal will show up, and it also implies the options `--app --no-prompt`.
 
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
+scribe-install
+scribe-install --name "Scribe Whisper" --backend whisper --model small --clipboard --restart-after-silence --no-prompt
+scribe-install --name "Scribe Vosk FR" --backend vosk --language fr --keyboard --clipboard --no-terminal
 ```
-
-After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+This will install three separate apps:
+- `Super + scribe` : will launch the default version with terminal prompt
+- `Super + whisper` : will launch a present version with the `small` model from `whisper` and start recording right away. You can see what is going on in the terminal and the result is ready to paste from the clipboard
+- `Super + vosk fr` : will launch a preset version for real-time transcription in French with the `vosk` backend, and throughput to the clipboard and the keyboard, not even opening a terminal.
 
 
 ## Fine tuning

{scribe_cli-0.8.0 → scribe_cli-0.9.0}/README.md

@@ -138,15 +138,20 @@ pip install PyGObject
 ## 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`
-to make it available from the quick launch menu. Any option will be passed on to `scribe`.
+to make it available from the quick launch menu. Any option will be passed on to `scribe`, with the additional options `--name` and `--no-terminal`.
+`--no-terminal` means no terminal will show up, and it also implies the options `--app --no-prompt`.
 
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
+scribe-install
+scribe-install --name "Scribe Whisper" --backend whisper --model small --clipboard --restart-after-silence --no-prompt
+scribe-install --name "Scribe Vosk FR" --backend vosk --language fr --keyboard --clipboard --no-terminal
 ```
-
-After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+This will install three separate apps:
+- `Super + scribe` : will launch the default version with terminal prompt
+- `Super + whisper` : will launch a present version with the `small` model from `whisper` and start recording right away. You can see what is going on in the terminal and the result is ready to paste from the clipboard
+- `Super + vosk fr` : will launch a preset version for real-time transcription in French with the `vosk` backend, and throughput to the clipboard and the keyboard, not even opening a terminal.
 
 
 ## Fine tuning

{scribe_cli-0.8.0 → scribe_cli-0.9.0}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.9.0'
+__version_tuple__ = version_tuple = (0, 9, 0)

{scribe_cli-0.8.0 → scribe_cli-0.9.0}/scribe/app.py

@@ -301,7 +301,7 @@ def create_app(micro, transcriber, **kwargs):
     def callback_stop_recording(icon, item):
         # Here we need to stop the recording thread
 
-        transcriber.recording = False
+        transcriber.interrupt = True
         if hasattr(icon, "_recording_thread"):
             icon._recording_thread.join()
         if hasattr(icon, "_monitoring_thread"):
@@ -362,13 +362,15 @@ def main(args=None):
             transcriber = get_transcriber(o, prompt=o.prompt)
         print(f"Model [{colored(transcriber.model_name, 'light_blue', attrs=['bold'])}] from [{colored(transcriber.backend, 'light_blue', attrs=['bold'])}] selected.")
         show_output = ["clipboard", "keyboard", "output_file"]
-        show_options = ["ascii", "app"]
+        show_options = ["ascii", "restart_after_silence"]
         activated_output = [colored(option if type(getattr(o, option)) is bool else f'{option}={getattr(o, option)}', 'light_blue') for option in show_output if getattr(o, option)]
         activated_options = [colored(option if type(getattr(o, option)) is bool else f'{option}={getattr(o, option)}', 'light_blue') for option in show_options if getattr(o, option)]
         if activated_output:
             print(f"Output: {' | '.join(activated_output)}")
         else:
             print(colored(f"No output selected -> terminal only", "light_red"))
+        if o.app:
+            print(colored("App mode enabled", "light_green"))
         if activated_options:
             print(f"Options: {' | '.join(activated_options)}")
         if o.prompt:
@@ -421,7 +423,7 @@ def main(args=None):
                 o.app = not o.app
                 continue
             if key == "a":
-                transcriber.restart_after_silence = not transcriber.restart_after_silence
+                o.restart_after_silence = transcriber.restart_after_silence = not transcriber.restart_after_silence
                 continue
             if key == "t":
                 ans = input(f"Enter new duration in seconds (current: {transcriber.timeout}): ")

{scribe_cli-0.8.0 → scribe_cli-0.9.0}/scribe/install_desktop.py

@@ -10,9 +10,17 @@ def main():
         sys.exit(0)
 
     parser = argparse.ArgumentParser("Install the desktop file for the scribe package. Any arguments to this script will be passed on to `scribe`.")
+    parser.add_argument("--name", help="The title of the desktop app", default="Scribe")
+    parser.add_argument("--startup-wm-class")
+    parser.add_argument("--no-terminal", action="store_false", dest="terminal", help="Don't show the terminal (goes in --app mode)")
     o, rest = parser.parse_known_args()
     o.arguments = rest
 
+    if not o.terminal and "--app" not in o.arguments:
+        o.arguments.append("--app")
+    if not o.terminal and "--no-prompt" not in o.arguments:
+        o.arguments.append("--no-prompt")
+
     SOURCE_SCRIBE_DATA = os.path.dirname(scribe_data.__file__)
 
     HOME = os.environ.get('HOME',os.path.expanduser('~'))
@@ -25,15 +33,18 @@ def main():
     with open(os.path.join(SOURCE_SCRIBE_DATA, 'templates', 'scribe.desktop')) as f:
         template = f.read()
 
+    simple_name = o.name.lower().replace(' ','-').replace(os.path.sep, '-')
     bin_folder = sysconfig.get_path("scripts")
     icon_folder = os.path.join(SOURCE_SCRIBE_DATA, 'share')
-    desktop_filecontent = template.format(icon_folder=icon_folder, bin_folder=bin_folder, options=' '.join(o.arguments) if o.arguments else '')
+    desktop_filecontent = template.format(icon_folder=icon_folder, bin_folder=bin_folder,
+                                          name=o.name, terminal=str(o.terminal).lower(),
+                                          StartupWMClass=o.startup_wm_class or f"crx_mpnasdanpmm_{simple_name}",
+                                          options=' ' + ' '.join(o.arguments) if o.arguments else '')
 
-    desktop_filepath = os.path.join(XDG_APP_DATA, 'scribe.desktop')
+    desktop_filepath = os.path.join(XDG_APP_DATA, f'{simple_name}.desktop')
     print("Writing GNOME desktop file:", desktop_filepath)
     with open(desktop_filepath, "w") as f:
         f.write(desktop_filecontent)
 
-
 if __name__ == "__main__":
     main()

{scribe_cli-0.8.0 → scribe_cli-0.9.0}/scribe/models.py

@@ -35,6 +35,7 @@ class AbstractTranscriber:
         self.recording = False
         self.busy = False
         self.waiting = False
+        self.interrupt = False
         self.reset()
 
     def get_elapsed(self):
@@ -59,6 +60,7 @@ class AbstractTranscriber:
                         stop_message="Done transcribing."):
 
         self.reset()
+        self.interrupt = False
         self.recording = True
         self.waiting = True
         self.busy = True
@@ -73,7 +75,7 @@ class AbstractTranscriber:
             with microphone.open_stream():
                 print(start_message)
 
-                while self.recording:
+                while not self.interrupt:
                     while not microphone.q.empty():
                         data = microphone.q.get()
 

{scribe_cli-0.8.0 → scribe_cli-0.9.0/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.8.0
+Version: 0.9.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
@@ -201,15 +201,20 @@ pip install PyGObject
 ## 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`
-to make it available from the quick launch menu. Any option will be passed on to `scribe`.
+to make it available from the quick launch menu. Any option will be passed on to `scribe`, with the additional options `--name` and `--no-terminal`.
+`--no-terminal` means no terminal will show up, and it also implies the options `--app --no-prompt`.
 
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
+scribe-install
+scribe-install --name "Scribe Whisper" --backend whisper --model small --clipboard --restart-after-silence --no-prompt
+scribe-install --name "Scribe Vosk FR" --backend vosk --language fr --keyboard --clipboard --no-terminal
 ```
-
-After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+This will install three separate apps:
+- `Super + scribe` : will launch the default version with terminal prompt
+- `Super + whisper` : will launch a present version with the `small` model from `whisper` and start recording right away. You can see what is going on in the terminal and the result is ready to paste from the clipboard
+- `Super + vosk fr` : will launch a preset version for real-time transcription in French with the `vosk` backend, and throughput to the clipboard and the keyboard, not even opening a terminal.
 
 
 ## Fine tuning

scribe_cli-0.9.0/scribe_data/templates/scribe.desktop

@@ -0,0 +1,8 @@
+#!/usr/bin/env xdg-open
+[Desktop Entry]
+Terminal={terminal}
+Type=Application
+Name={name}
+Exec={bin_folder}/scribe{options}
+Icon={icon_folder}/icon.png
+StartupWMClass={StartupWMClass}

scribe_cli-0.8.0/scribe_data/templates/scribe.desktop

@@ -1,8 +0,0 @@
-#!/usr/bin/env xdg-open
-[Desktop Entry]
-Terminal=true
-Type=Application
-Name=Scribe
-Exec={bin_folder}/scribe{options}
-Icon={icon_folder}/icon.jpg
-StartupWMClass=crx_mpnasdanpmmopoasdjdcgaaiekailkhb