scribe-cli 0.12.4__tar.gz → 0.13.1__tar.gz

{scribe_cli-0.12.4/scribe_cli.egg-info → scribe_cli-0.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.12.4
+Version: 0.13.1
 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
@@ -33,7 +33,7 @@ License: MIT License
         licenses of all dependencies before using or distributing this software to
         ensure compliance with their respective terms.
 Project-URL: Homepage, https://github.com/perrette/scribe
-Keywords: speech recognition,transcription,AI,language,vosk,whisper,openai,keyboard,clipboard
+Keywords: speech-to-text,speech recognition,transcription,language,AI,local,API,vosk,whisper,openai,keyboard,clipboard
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -171,8 +171,8 @@ You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
-By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
+With the `whisper` model (`whisper` and `openaiapi` backends) the registration continues for 2 minutes until you stop the registration manually to trigger the transcription (Stop in the app, Ctrl + C in the terminal).
+These parameters can be changed. There is also the possibility to interrupt after a silence is detected. You would do: `--silence -40 --duration-duration 2` to interrupt the registration when a silence (less than -40 db recorded) lasts for more than 2 seconds. This is experimental, and the default is an exceedingly low silence threshold of -200 db and a silence duration of 120 s to effectively disable that feature and keep full manual control.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -269,8 +269,8 @@ to make it available from the quick launch menu. Any option will be passed on to
 
 Consider the following two flavors:
 ```bash
-scribe-install --clipboard ...
-scribe-install --name "Scribe App" --no-terminal --clipboard ...
+scribe-install --name "Scribe Terminal" --clipboard ...
+scribe-install --name "Scribe" --no-terminal --clipboard ...
 ```
 The first will create an app named Scribe (the default) that simply opens a terminal and execute the command `scribe --clipboard ...`.
 The second will create an app named Scribe App that executes in a hidden terminal: `scribe --no-prompt --app --clipboard ...`, thus leaving the tray icon as only mode of interaction.

{scribe_cli-0.12.4 → scribe_cli-0.13.1}/README.md

@@ -99,8 +99,8 @@ You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
-By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
+With the `whisper` model (`whisper` and `openaiapi` backends) the registration continues for 2 minutes until you stop the registration manually to trigger the transcription (Stop in the app, Ctrl + C in the terminal).
+These parameters can be changed. There is also the possibility to interrupt after a silence is detected. You would do: `--silence -40 --duration-duration 2` to interrupt the registration when a silence (less than -40 db recorded) lasts for more than 2 seconds. This is experimental, and the default is an exceedingly low silence threshold of -200 db and a silence duration of 120 s to effectively disable that feature and keep full manual control.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -197,8 +197,8 @@ to make it available from the quick launch menu. Any option will be passed on to
 
 Consider the following two flavors:
 ```bash
-scribe-install --clipboard ...
-scribe-install --name "Scribe App" --no-terminal --clipboard ...
+scribe-install --name "Scribe Terminal" --clipboard ...
+scribe-install --name "Scribe" --no-terminal --clipboard ...
 ```
 The first will create an app named Scribe (the default) that simply opens a terminal and execute the command `scribe --clipboard ...`.
 The second will create an app named Scribe App that executes in a hidden terminal: `scribe --no-prompt --app --clipboard ...`, thus leaving the tray icon as only mode of interaction.

{scribe_cli-0.12.4 → scribe_cli-0.13.1}/pyproject.toml

@@ -32,10 +32,13 @@ classifiers = [
 ]
 
 keywords = [
+    "speech-to-text",
     "speech recognition",
     "transcription",
-    "AI",
     "language",
+    "AI",
+    "local",
+    "API",
     "vosk",
     "whisper",
     "openai",

{scribe_cli-0.12.4 → scribe_cli-0.13.1}/scribe/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.12.4'
-__version_tuple__ = version_tuple = (0, 12, 4)
+__version__ = version = '0.13.1'
+__version_tuple__ = version_tuple = (0, 13, 1)

{scribe_cli-0.12.4 → scribe_cli-0.13.1}/scribe/app.py

@@ -202,8 +202,8 @@ def get_parser():
 
     group = parser.add_argument_group("whisper options")
     group.add_argument("--duration", default=120, type=float, help="Max duration of the whisper recording (default %(default)s s)")
-    group.add_argument("--silence", default=2, type=float, help="silence duration (default %(default)s s)")
-    group.add_argument("--silence-db", default=-40, type=float, help="silence magnitude in decibel (default %(default)s db)")
+    group.add_argument("--silence", default=120, type=float, help="silence duration (default %(default)s s)")
+    group.add_argument("--silence-db", default=-200, 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.")
 
@@ -413,9 +413,10 @@ def create_app(micro, transcriber, other_transcribers=None, transcriber_options=
     menus.append(Item("Choose Model", pystrayMenu(
         *(Item(f"{name}", callback_set_model, checked=is_checked_model) for name in other_transcribers_dict)))
     )
-    menus.append(Item("Toggle Options", pystrayMenu(
-        *(Item(f"{name}", callback_toggle_option, checked=is_checked_option, visible=is_option_visible) for name in options)))
-    )
+    if options:
+        menus.append(Item("Toggle Options", pystrayMenu(
+            *(Item(f"{name}", callback_toggle_option, checked=is_checked_option, visible=is_option_visible) for name in options)))
+        )
     menus.append(Item('Quit', callback_quit))
 
     # Create a menu
@@ -567,7 +568,7 @@ def main(args=None):
                 *[{**_filter_options(vars(o), exclude=VoskTranscriber._frozen_options), "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,
-                             transcriber_options=["restart_after_silence"], **greetings)
+                             transcriber_options=[], **greetings)
             print("Starting app...")
             app.run()
         else:

{scribe_cli-0.12.4 → scribe_cli-0.13.1/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.12.4
+Version: 0.13.1
 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
@@ -33,7 +33,7 @@ License: MIT License
         licenses of all dependencies before using or distributing this software to
         ensure compliance with their respective terms.
 Project-URL: Homepage, https://github.com/perrette/scribe
-Keywords: speech recognition,transcription,AI,language,vosk,whisper,openai,keyboard,clipboard
+Keywords: speech-to-text,speech recognition,transcription,language,AI,local,API,vosk,whisper,openai,keyboard,clipboard
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -171,8 +171,8 @@ You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
-By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
+With the `whisper` model (`whisper` and `openaiapi` backends) the registration continues for 2 minutes until you stop the registration manually to trigger the transcription (Stop in the app, Ctrl + C in the terminal).
+These parameters can be changed. There is also the possibility to interrupt after a silence is detected. You would do: `--silence -40 --duration-duration 2` to interrupt the registration when a silence (less than -40 db recorded) lasts for more than 2 seconds. This is experimental, and the default is an exceedingly low silence threshold of -200 db and a silence duration of 120 s to effectively disable that feature and keep full manual control.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -269,8 +269,8 @@ to make it available from the quick launch menu. Any option will be passed on to
 
 Consider the following two flavors:
 ```bash
-scribe-install --clipboard ...
-scribe-install --name "Scribe App" --no-terminal --clipboard ...
+scribe-install --name "Scribe Terminal" --clipboard ...
+scribe-install --name "Scribe" --no-terminal --clipboard ...
 ```
 The first will create an app named Scribe (the default) that simply opens a terminal and execute the command `scribe --clipboard ...`.
 The second will create an app named Scribe App that executes in a hidden terminal: `scribe --no-prompt --app --clipboard ...`, thus leaving the tray icon as only mode of interaction.