scribe-cli 0.7.4__tar.gz → 0.7.6__tar.gz

{scribe_cli-0.7.4/scribe_cli.egg-info → scribe_cli-0.7.6}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.4
-Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI.
+Version: 0.7.6
+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
         
@@ -44,31 +44,43 @@ 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
 Requires-Dist: openai-whisper; extra == "whisper"
 Provides-Extra: vosk
 Requires-Dist: vosk; extra == "vosk"
+Provides-Extra: app
+Requires-Dist: pystray; extra == "app"
+Requires-Dist: PyGObject; extra == "app"
 Provides-Extra: all
 Requires-Dist: pynput; extra == "all"
 Requires-Dist: openai-whisper; extra == "all"
 Requires-Dist: vosk; extra == "all"
+Requires-Dist: pystray; extra == "all"
+
+[![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
+[![pypi](https://github.com/perrette/scribe/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/papers-cli)
 
 # Scribe
 
-`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.
+`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).
+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
 
-Install PortAudio library. E.g. on Ubuntu:
+Install PortAudio library and xclip library. E.g. on Ubuntu:
 
 ```bash
-sudo apt-get install portaudio19-dev
+sudo apt-get install portaudio19-dev xclip
 ```
 
-The python dependencies should be dealt with automatically:
+See additional requirements for the [icon tray](#system-tray-icon-experimental) and [keyboard](#virtual-keyboard-experimental) options. The python dependencies should be dealt with automatically:
 
 ```bash
 pip install scribe-cli[all]"
@@ -108,8 +120,7 @@ but it cannot do real-time, and depending on the model can have relatively long
 With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
 there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
 
-The `vosk` backend is good at
-doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
+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.
 Use mainly for longer typing session with the [keyboard](#virtual-keyboard-advanced) option, e.g. to make notes.
 There are many [vosk models](https://alphacephei.com/vosk/models) available, and here a few are associated to [a handful of languages](scribe/models.toml) `en`, `fr`, `it`, `de` (so far).
 
@@ -132,8 +143,7 @@ scribe --keyboard
 ```
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
-
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+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
 
@@ -141,14 +151,15 @@ In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in ch
 
 One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
 
-Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+Another workaround while staying with Wayland is to use the low-level `uinput` backend of `pynput`, but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent).
+Moreover, the keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered is that the special characters (`é`) were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
 ```bash
 sudo modprobe uinput
 sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
 ```
 You're on the right path :)
 
-### System try icon (experimental)
+### System tray 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:

{scribe_cli-0.7.4 → scribe_cli-0.7.6}/README.md

@@ -1,16 +1,25 @@
+[![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
+[![pypi](https://github.com/perrette/scribe/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/papers-cli)
+
 # Scribe
 
-`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.
+`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).
+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
 
-Install PortAudio library. E.g. on Ubuntu:
+Install PortAudio library and xclip library. E.g. on Ubuntu:
 
 ```bash
-sudo apt-get install portaudio19-dev
+sudo apt-get install portaudio19-dev xclip
 ```
 
-The python dependencies should be dealt with automatically:
+See additional requirements for the [icon tray](#system-tray-icon-experimental) and [keyboard](#virtual-keyboard-experimental) options. The python dependencies should be dealt with automatically:
 
 ```bash
 pip install scribe-cli[all]"
@@ -50,8 +59,7 @@ but it cannot do real-time, and depending on the model can have relatively long
 With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
 there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
 
-The `vosk` backend is good at
-doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
+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.
 Use mainly for longer typing session with the [keyboard](#virtual-keyboard-advanced) option, e.g. to make notes.
 There are many [vosk models](https://alphacephei.com/vosk/models) available, and here a few are associated to [a handful of languages](scribe/models.toml) `en`, `fr`, `it`, `de` (so far).
 
@@ -74,8 +82,7 @@ scribe --keyboard
 ```
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
-
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+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
 
@@ -83,14 +90,15 @@ In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in ch
 
 One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
 
-Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+Another workaround while staying with Wayland is to use the low-level `uinput` backend of `pynput`, but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent).
+Moreover, the keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered is that the special characters (`é`) were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
 ```bash
 sudo modprobe uinput
 sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
 ```
 You're on the right path :)
 
-### System try icon (experimental)
+### System tray 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:

{scribe_cli-0.7.4 → scribe_cli-0.7.6}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "scribe-cli"
 dynamic = ["version"]
-description = "scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI."
+description = "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"
 authors = [
     { name="Mahé Perrette", email="mahe.perrette@gmail.com" }
 ]
@@ -18,9 +18,7 @@ dependencies = [
     "tqdm",
     "requests",
     "pyperclip",
-    "pystray",
 ]
-optional-dependencies = { keyboard = ["pynput"], whisper = ["openai-whisper"], vosk = ["vosk"], all = ["pynput", "openai-whisper", "vosk"] }
 
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -39,6 +37,14 @@ keywords = [
     "clipboard",
 ]
 
+[project.optional-dependencies]
+keyboard = ["pynput"]
+whisper = ["openai-whisper"]
+vosk = ["vosk"]
+app = ["pystray", "PyGObject"]
+all = ["pynput", "openai-whisper", "vosk", "pystray"]
+
+
 [tool.setuptools]
 packages = [ "scribe", "scribe_data" ]
 

{scribe_cli-0.7.4 → scribe_cli-0.7.6}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.4'
-__version_tuple__ = version_tuple = (0, 7, 4)
+__version__ = version = '0.7.6'
+__version_tuple__ = version_tuple = (0, 7, 6)

{scribe_cli-0.7.4 → scribe_cli-0.7.6/scribe_cli.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.4
-Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI.
+Version: 0.7.6
+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
         
@@ -44,31 +44,43 @@ 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
 Requires-Dist: openai-whisper; extra == "whisper"
 Provides-Extra: vosk
 Requires-Dist: vosk; extra == "vosk"
+Provides-Extra: app
+Requires-Dist: pystray; extra == "app"
+Requires-Dist: PyGObject; extra == "app"
 Provides-Extra: all
 Requires-Dist: pynput; extra == "all"
 Requires-Dist: openai-whisper; extra == "all"
 Requires-Dist: vosk; extra == "all"
+Requires-Dist: pystray; extra == "all"
+
+[![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
+[![pypi](https://github.com/perrette/scribe/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/papers-cli)
 
 # Scribe
 
-`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.
+`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).
+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
 
-Install PortAudio library. E.g. on Ubuntu:
+Install PortAudio library and xclip library. E.g. on Ubuntu:
 
 ```bash
-sudo apt-get install portaudio19-dev
+sudo apt-get install portaudio19-dev xclip
 ```
 
-The python dependencies should be dealt with automatically:
+See additional requirements for the [icon tray](#system-tray-icon-experimental) and [keyboard](#virtual-keyboard-experimental) options. The python dependencies should be dealt with automatically:
 
 ```bash
 pip install scribe-cli[all]"
@@ -108,8 +120,7 @@ but it cannot do real-time, and depending on the model can have relatively long
 With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
 there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
 
-The `vosk` backend is good at
-doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
+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.
 Use mainly for longer typing session with the [keyboard](#virtual-keyboard-advanced) option, e.g. to make notes.
 There are many [vosk models](https://alphacephei.com/vosk/models) available, and here a few are associated to [a handful of languages](scribe/models.toml) `en`, `fr`, `it`, `de` (so far).
 
@@ -132,8 +143,7 @@ scribe --keyboard
 ```
 
 It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
-
-`pynput` may require [some configuration](https://pynput.readthedocs.io/en/latest/limitations.html). It has [limitations]((https://pynput.readthedocs.io/en/latest/limitations.html)).
+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
 
@@ -141,14 +151,15 @@ In my Ubuntu + Wayland system the keyboard simulation works out-of-the-box in ch
 
 One workaround is to use the Xorg version of GNOME: in `etc/gdm3/custom.conf` uncomment `# WaylandEnable=false` and restart your computer.
 
-Another workaround with Wayland is to use the low-level `uinput` backend but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent). Moreover, since `uinput` really only simulates key strokes, your keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered the caveat that the special characters were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
+Another workaround while staying with Wayland is to use the low-level `uinput` backend of `pynput`, but that requires that `scribe` is run as root (sudo), and likely other configurations like activating the `uinput` system module (`sudo modprobe uinput` for a one-time test, or adding `uinput` to `/etc/modules-load.d/modules.conf` to make that persistent).
+Moreover, the keyboard must be set with an appropriate layout, for example to have the letter `é` you'd want a French or Italian layout otherwise the English will drop it or replace with something else. Another caveat I encountered is that the special characters (`é`) were inserted at the wrong place. Adding a small delay was enough to fix that with the additional parameter `--latency 0.01` Finally if you run as sudo you may need to reset some environment variable so that the list of audio devices (`XDG_RUNTIME_DIR`) and the download folder remain the same. To sum-up, that gives something like:
 ```bash
 sudo modprobe uinput
 sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput $(which scribe)  --latency 0.01
 ```
 You're on the right path :)
 
-### System try icon (experimental)
+### System tray 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:

{scribe_cli-0.7.4 → scribe_cli-0.7.6}/scribe_cli.egg-info/requires.txt

@@ -3,12 +3,16 @@ sounddevice
 tqdm
 requests
 pyperclip
-pystray
 
 [all]
 pynput
 openai-whisper
 vosk
+pystray
+
+[app]
+pystray
+PyGObject
 
 [keyboard]
 pynput