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

{scribe_cli-0.11.1/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.1
+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
@@ -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
@@ -220,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 --restart-after-silence --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.1 → scribe_cli-0.12.0}/README.md

@@ -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
@@ -152,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 --restart-after-silence --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.1 → 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.1'
-__version_tuple__ = version_tuple = (0, 11, 1)
+__version__ = version = '0.12.0'
+__version_tuple__ = version_tuple = (0, 12, 0)

{scribe_cli-0.11.1 → 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
 
@@ -351,6 +355,7 @@ def create_app(micro, transcriber, other_transcribers=None, **kwargs):
         icon.update_menu()
 
     def callback_toggle_option(icon, item):
+        callback_stop_recording(icon, item)
         kwargs[str(item)] = not kwargs[str(item)]
 
     def is_model_selection(item):
@@ -525,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.1 → 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.1
+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
@@ -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
@@ -220,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 --restart-after-silence --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