scribe-cli 0.7.9__tar.gz → 0.7.10__tar.gz

{scribe_cli-0.7.9/scribe_cli.egg-info → scribe_cli-0.7.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.9
+Version: 0.7.10
 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
@@ -64,14 +64,17 @@ Requires-Dist: pystray; extra == "all"
 [![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
 [![pypi](https://img.shields.io/pypi/v/scribe-cli)](https://pypi.org/project/scribe-cli)
 
-# Scribe
+# Scribe  <img src="scribe_data/share/icon.png" width=48px>
 
 `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.
 
 ## Compatibility
 
-In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) and develop it for my own purposes so glitches are likely on other configurations.
-As of February 19, 2025 python 13 is not supported (I can't recall now which dependency is to blame).
+In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) for my own purposes so glitches are likely on other configurations.
+Moreover there are quite a bit of dependencies that rely on very OS-specific protocols under the hood, like access to the microphone, keyboard and clipboard,
+and even though the python dependencies `scribe` relies on are not restricted to a single platform, there may be limitation and additional binaries to install.
+This guide is based on python3.12 running on Ubuntu 24.04 with Gnome + Wayland, which is a relatively standard setting at the time of writing.
+Note as of February 19, 2025 python 13 does not seem to produce any transcription (I am not sure which dependency is to blame).
 A test on Mac OS (M1 Air with 8Gb RAM) worked with python 12, though with a much inferior performance compared to my own system (Lenovo T14 Gen 5 with i5 125U 32 Gb RAM).
 
 ## Installation
@@ -147,7 +150,7 @@ scribe --keyboard
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
-#### Use the keyboard in Ubuntu
+#### Use the keyboard with Wayland (default for Ubuntu 24.04)
 
 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.
 
@@ -161,7 +164,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental)
+### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -176,7 +179,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in Ubuntu
+### 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`.

{scribe_cli-0.7.9 → scribe_cli-0.7.10}/README.md

@@ -1,14 +1,17 @@
 [![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
 [![pypi](https://img.shields.io/pypi/v/scribe-cli)](https://pypi.org/project/scribe-cli)
 
-# Scribe
+# Scribe  <img src="scribe_data/share/icon.png" width=48px>
 
 `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.
 
 ## Compatibility
 
-In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) and develop it for my own purposes so glitches are likely on other configurations.
-As of February 19, 2025 python 13 is not supported (I can't recall now which dependency is to blame).
+In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) for my own purposes so glitches are likely on other configurations.
+Moreover there are quite a bit of dependencies that rely on very OS-specific protocols under the hood, like access to the microphone, keyboard and clipboard,
+and even though the python dependencies `scribe` relies on are not restricted to a single platform, there may be limitation and additional binaries to install.
+This guide is based on python3.12 running on Ubuntu 24.04 with Gnome + Wayland, which is a relatively standard setting at the time of writing.
+Note as of February 19, 2025 python 13 does not seem to produce any transcription (I am not sure which dependency is to blame).
 A test on Mac OS (M1 Air with 8Gb RAM) worked with python 12, though with a much inferior performance compared to my own system (Lenovo T14 Gen 5 with i5 125U 32 Gb RAM).
 
 ## Installation
@@ -84,7 +87,7 @@ scribe --keyboard
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
-#### Use the keyboard in Ubuntu
+#### Use the keyboard with Wayland (default for Ubuntu 24.04)
 
 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.
 
@@ -98,7 +101,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental)
+### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -113,7 +116,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in Ubuntu
+### 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`.

{scribe_cli-0.7.9 → scribe_cli-0.7.10}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.9'
-__version_tuple__ = version_tuple = (0, 7, 9)
+__version__ = version = '0.7.10'
+__version_tuple__ = version_tuple = (0, 7, 10)

{scribe_cli-0.7.9 → scribe_cli-0.7.10}/scribe/app.py

@@ -112,16 +112,17 @@ def get_transcriber(o, prompt=True):
                 choices = list(zip(available_models, available_languages)) + [f" * [Any model from {ansi_link('https://alphacephei.com/vosk/models')}]"]
                 default_model = choices[0]  # this is a tuple !!
 
-            print(f"For information about vosk models see: {ansi_link('https://alphacephei.com/vosk/models')}")
             if prompt:
+                print(f"For information about vosk models see: {ansi_link('https://alphacephei.com/vosk/models')}")
                 model = prompt_choices(choices, default=default_model, label="model")  # this always returns a string
             else:
                 model = default_model[0] if isinstance(default_model, tuple) else default_model  # tuple -> string
 
         elif backend == "whisper":
             default_model = "small"
-            print("Some models have a specialized English version (.en) which will be selected as default is `-l en` was requested, but can also be requested explicitly below (option not listed). See [documentation](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages).")
             if prompt:
+                # print("Some models have a specialized English version (.en) which will be selected as default is `-l en` was requested, but can also be requested explicitly below (option not listed). See [documentation](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages).")
+                print(f"See {ansi_link('https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages')} for available models.")
                 model = prompt_choices(whisper_models, default=default_model, label="model",
                                         hidden_models=whisper_english_models)
             else:
@@ -338,38 +339,47 @@ def main(args=None):
     micro = Microphone(samplerate=o.samplerate, device=o.microphone_device)
 
     transcriber = None
-
-    toggle = {True: "On", False: "Off"}
+    details = False
 
     while True:
         if transcriber is 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_options = ["clipboard", "keyboard", "ascii", "app"]
+        activated_options = [colored(option, 'light_blue') for option in show_options if getattr(o, option)]
+        print(f"Options: {' | '.join(activated_options)}")
         if o.prompt:
             print(f"Choose any of the following actions")
             print(f"{colored('[q]', 'light_yellow')} quit")
             print(f"{colored('[e]', 'light_yellow')} change model")
-            print(f"{colored('[x]', 'light_yellow')} app is {colored(o.app, 'light_blue')} toggle?")
-            print(f"{colored('[c]', 'light_yellow')} clipboard is {colored(o.clipboard, 'light_blue')} toggle?")
-            print(f"{colored('[k]', 'light_yellow')} keyboard is {colored(o.keyboard, 'light_blue')} toggle?")
-            if o.keyboard:
-                print(f"{colored('[latency]', 'light_yellow')} between keystrokes is {colored(o.latency, 'light_blue')} s")
-            if transcriber.backend == "whisper":
-                print(f"{colored('[t]', 'light_yellow')} change duration (currently {colored(transcriber.timeout, 'light_blue')} s)")
-                print(f"{colored('[b]', 'light_yellow')} change silence duration (currently {colored(transcriber.silence_duration, 'light_blue')} s)")
-                print(f"{colored('[a]', 'light_yellow')} auto-restart after silence is {colored(transcriber.restart_after_silence, 'light_blue')} toggle?")
-            exclude_flags = ["keyboard", "clipboard", "app", "prompt", "restart_after_silence"]
-            display_flags = [a.dest for a in parser._actions if a.help != argparse.SUPPRESS]
-            for key, value in vars(o).items():
-                if key not in display_flags or key in exclude_flags or not isinstance(value, bool):
-                    continue
-                print(f"{colored(f'[{key}]', 'light_yellow')} is {colored(value, 'light_blue')} toggle?")
+            if details:
+                print(f"{colored('[x]', 'light_yellow')} app is {colored(o.app, 'light_blue')} toggle?")
+                print(f"{colored('[c]', 'light_yellow')} clipboard is {colored(o.clipboard, 'light_blue')} toggle?")
+                print(f"{colored('[k]', 'light_yellow')} keyboard is {colored(o.keyboard, 'light_blue')} toggle?")
+                if o.keyboard:
+                    print(f"{colored('[latency]', 'light_yellow')} between keystrokes is {colored(o.latency, 'light_blue')} s")
+                if transcriber.backend == "whisper":
+                    print(f"{colored('[t]', 'light_yellow')} change duration (currently {colored(transcriber.timeout, 'light_blue')} s)")
+                    print(f"{colored('[b]', 'light_yellow')} change silence (currently {colored(transcriber.silence_duration, 'light_blue')} s)")
+                    print(f"{colored('[a]', 'light_yellow')} auto-restart after silence is {colored(transcriber.restart_after_silence, 'light_blue')} toggle?")
+                exclude_flags = ["keyboard", "clipboard", "app", "prompt", "restart_after_silence"]
+                display_flags = [a.dest for a in parser._actions if a.help != argparse.SUPPRESS]
+                for key, value in vars(o).items():
+                    if key not in display_flags or key in exclude_flags or not isinstance(value, bool):
+                        continue
+                    print(f"{colored(f'[{key}]', 'light_yellow')} is {colored(value, 'light_blue')} toggle?")
+                print(f"{colored('[o]', 'light_yellow')} hide options")
+            else:
+                print(f"{colored('[o]', 'light_yellow')} show options")
 
             print(colored(f"Press [Enter] to start recording.", attrs=["bold"]))
 
             key = input()
             if key == "q":
                 exit(0)
+            if key == "o":
+                details = not details
+                continue
             if key == "e":
                 transcriber = None
                 o.model = None

{scribe_cli-0.7.9 → scribe_cli-0.7.10/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.9
+Version: 0.7.10
 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
@@ -64,14 +64,17 @@ Requires-Dist: pystray; extra == "all"
 [![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
 [![pypi](https://img.shields.io/pypi/v/scribe-cli)](https://pypi.org/project/scribe-cli)
 
-# Scribe
+# Scribe  <img src="scribe_data/share/icon.png" width=48px>
 
 `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.
 
 ## Compatibility
 
-In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) and develop it for my own purposes so glitches are likely on other configurations.
-As of February 19, 2025 python 13 is not supported (I can't recall now which dependency is to blame).
+In principle `scribe` is compatible with any OS but I develop it under Ubuntu (Wayland) for my own purposes so glitches are likely on other configurations.
+Moreover there are quite a bit of dependencies that rely on very OS-specific protocols under the hood, like access to the microphone, keyboard and clipboard,
+and even though the python dependencies `scribe` relies on are not restricted to a single platform, there may be limitation and additional binaries to install.
+This guide is based on python3.12 running on Ubuntu 24.04 with Gnome + Wayland, which is a relatively standard setting at the time of writing.
+Note as of February 19, 2025 python 13 does not seem to produce any transcription (I am not sure which dependency is to blame).
 A test on Mac OS (M1 Air with 8Gb RAM) worked with python 12, though with a much inferior performance compared to my own system (Lenovo T14 Gen 5 with i5 125U 32 Gb RAM).
 
 ## Installation
@@ -147,7 +150,7 @@ scribe --keyboard
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
-#### Use the keyboard in Ubuntu
+#### Use the keyboard with Wayland (default for Ubuntu 24.04)
 
 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.
 
@@ -161,7 +164,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental)
+### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -176,7 +179,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in Ubuntu
+### 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`.