scribe-cli 0.6.2__tar.gz → 0.7.0__tar.gz

{scribe_cli-0.6.2/scribe_cli.egg-info → scribe_cli-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.6.2
+Version: 0.7.0
 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
@@ -44,6 +44,7 @@ Requires-Dist: sounddevice
 Requires-Dist: tqdm
 Requires-Dist: requests
 Requires-Dist: pyperclip
+Requires-Dist: pystray
 Provides-Extra: keyboard
 Requires-Dist: pynput; extra == "keyboard"
 Provides-Extra: whisper
@@ -131,6 +132,20 @@ It relies on the optional `pynput` dependency (installed together with `scribe`
 
 `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.
 
+### System try icon (experimental)
+
+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:
+```bash
+scribe --app
+```
+or toggle the app option in the interactive menu. The scribe icon will show, with Record or Quit options.
+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
+sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
+pip install PyGObject
+```
 
 ### Start as an application in Ubuntu
 

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/README.md

@@ -74,6 +74,20 @@ It relies on the optional `pynput` dependency (installed together with `scribe`
 
 `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.
 
+### System try icon (experimental)
+
+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:
+```bash
+scribe --app
+```
+or toggle the app option in the interactive menu. The scribe icon will show, with Record or Quit options.
+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
+sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
+pip install PyGObject
+```
 
 ### Start as an application in Ubuntu
 

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/pyproject.toml

@@ -18,6 +18,7 @@ dependencies = [
     "tqdm",
     "requests",
     "pyperclip",
+    "pystray",
 ]
 optional-dependencies = { keyboard = ["pynput"], whisper = ["openai-whisper"], vosk = ["vosk"], all = ["pynput", "openai-whisper", "vosk"] }
 
@@ -49,5 +50,5 @@ write_to = "scribe/_version.py"
 Homepage = "https://github.com/perrette/scribe"
 
 [project.scripts]
-scribe = "scribe.streamer:main"
+scribe = "scribe.app:main"
 scribe-install = "scribe.install_desktop:main"

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.6.2'
-__version_tuple__ = version_tuple = (0, 6, 2)
+__version__ = version = '0.7.0'
+__version_tuple__ = version_tuple = (0, 7, 0)

scribe_cli-0.6.2/scribe/streamer.py → scribe_cli-0.7.0/scribe/app.py

@@ -144,6 +144,7 @@ def get_parser():
                         help="An alias for preselected models when using the vosk backend, or 'en' for the English version of whisper models.")
 
     parser.add_argument("--no-prompt", action="store_false", dest="prompt", help="Disable prompts for backend and model selection and jump to recording")
+    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("--keyboard", action="store_true")
@@ -211,6 +212,41 @@ def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=
         print("Copied to clipboard.")
 
 
+def create_app(micro, transcriber, **kwargs):
+    import pystray
+    from pystray import Menu as pystrayMenu, MenuItem as Item
+    from PIL import Image
+    import PIL.ImageOps
+
+    import scribe_data
+
+    # 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
+        icon.stop()
+
+    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()
+
+    # Create a menu
+    menu = pystrayMenu(
+        Item('Record', callback_record),
+        Item('Quit', callback_quit),
+    )
+
+    # Create the system tray icon
+    icon = pystray.Icon('name', image, "My App", menu)
+
+    return icon
+
 
 def main(args=None):
 
@@ -233,6 +269,7 @@ def main(args=None):
             print(f"Choose any of the following actions:")
             print(f"[q] quit")
             print(f"[e] change model")
+            print(f"[x] toggle app [{toggle[o.app]}] -> [{toggle[not o.app]}]")
             print(f"[k] toggle keyboard [{toggle[o.keyboard]}] -> [{toggle[not o.keyboard]}]")
             print(f"[c] toggle clipboard [{toggle[o.clipboard]}] -> [{toggle[not o.clipboard]}]")
             if transcriber.backend == "whisper":
@@ -253,6 +290,9 @@ def main(args=None):
             if key == "c":
                 o.clipboard = not o.clipboard
                 continue
+            if key == "x":
+                o.app = not o.app
+                continue
             if key == "a":
                 transcriber.restart_after_silence = not transcriber.restart_after_silence
                 continue
@@ -271,7 +311,11 @@ def main(args=None):
                     print("Invalid duration. Must be an integer.")
                 continue
 
-        start_recording(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency)
+        if o.app:
+            app = create_app(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency)
+            app.run()
+        else:
+            start_recording(micro, transcriber, clipboard=o.clipboard, keyboard=o.keyboard, latency=o.latency)
 
         # 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.6.2 → scribe_cli-0.7.0/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.6.2
+Version: 0.7.0
 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
@@ -44,6 +44,7 @@ Requires-Dist: sounddevice
 Requires-Dist: tqdm
 Requires-Dist: requests
 Requires-Dist: pyperclip
+Requires-Dist: pystray
 Provides-Extra: keyboard
 Requires-Dist: pynput; extra == "keyboard"
 Provides-Extra: whisper
@@ -131,6 +132,20 @@ It relies on the optional `pynput` dependency (installed together with `scribe`
 
 `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.
 
+### System try icon (experimental)
+
+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:
+```bash
+scribe --app
+```
+or toggle the app option in the interactive menu. The scribe icon will show, with Record or Quit options.
+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
+sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
+pip install PyGObject
+```
 
 ### Start as an application in Ubuntu
 

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/scribe_cli.egg-info/SOURCES.txt

@@ -5,13 +5,13 @@ pyproject.toml
 .github/workflows/pypi.yml
 scribe/__init__.py
 scribe/_version.py
+scribe/app.py
 scribe/audio.py
 scribe/install_desktop.py
 scribe/keyboard.py
 scribe/models.py
 scribe/models.toml
 scribe/saverecording.py
-scribe/streamer.py
 scribe/testpynput.py
 scribe/util.py
 scribe_cli.egg-info/PKG-INFO

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/scribe_cli.egg-info/entry_points.txt

@@ -1,3 +1,3 @@
 [console_scripts]
-scribe = scribe.streamer:main
+scribe = scribe.app:main
 scribe-install = scribe.install_desktop:main

{scribe_cli-0.6.2 → scribe_cli-0.7.0}/scribe_cli.egg-info/requires.txt

@@ -3,6 +3,7 @@ sounddevice
 tqdm
 requests
 pyperclip
+pystray
 
 [all]
 pynput