python-clipboard-speaker

Want your computer to speak a bit? Mark some text and let it rip.
git clone https://kaka.farm/~git/python-clipboard-speaker
Log | Files | Refs | README | LICENSE

README.md (3282B)

      1 # Clipboard Speaker.
      2 
      3 **ARCHIVED!  Use [guile-clipboard-speaker][gcs] instead!**
      4 
      5     Want your computer
      6     to speak a bit?
      7     Mark some text
      8     and let it rip.
      9 
     10 Not a fancy curiosity but an accessibility tool for people with reading
     11 disabilities. I use it every day to read.
     12 
     13 It basically reads whatever you mark with your mouse cursor.
     14 
     15 ## Code repositories:
     16 
     17 Main development repository is on codeberg.org:
     18 
     19 https://git.sr.ht/~kakafarm/clipboard-speaker/
     20 
     21 Mirrors:
     22 
     23 * https://codeberg.org/yuvallangerontheroad/clipboard-speaker/
     24 * https://gitlab.com/yuvallangerontheroad/clipboard-speaker/
     25 * https://github.com/yuvallangerontheroad/clipboard-speaker/
     26 * https://gitlab.com/yuvallanger/clipboard-speaker/
     27 * https://github.com/yuvallanger/clipboard-speaker/
     28 
     29 ## Changelog:
     30 
     31 Have a look at the <a href="CHANGELOG.md">CHANGELOG.md</a> file.
     32 
     33 ## Newer Python version:
     34 
     35 ### Installation:
     36 
     37 #### Dependencies:
     38 
     39 * https://python.org/
     40 * https://github.com/espeak-ng/espeak-ng/
     41 * https://github.com/kfish/xsel
     42 
     43 #### Install the Dependencies:
     44 
     45 ##### On Debian based systems:
     46 
     47 `apt install espeak-ng xsel python3`
     48 
     49 #### Install the script files:
     50 
     51 ##### Manually:
     52 
     53 Copy the two executable scripts into your home bin directory:
     54 
     55 ```
     56 cp clipboard_speaker/clipboard_speaker.py ~/bin/clipboard-speaker
     57 cp clipboard_speaker/clipboard_speaker_kill.py ~/bin/clipboard-speaker-kill
     58 ```
     59 
     60 ##### pip:
     61 
     62 ```
     63 pip install --user .
     64 ```
     65 
     66 After which the script files are located, at least here in my system, under
     67 `~/.local/bin/` as `~/.local/bin/clipboard-speak` and
     68 `~/.local/bin/clipboard-speak-kill`.
     69 
     70 #### Map your keybindings:
     71 
     72 ##### On Gnome:
     73 
     74 Add the key bindings in (if you use Gnome. If you don't, look up how to
     75     assign scripts to keybindings in your own window manager):
     76 
     77 ```
     78 Gnome Settings
     79     → Keyboard Shortcuts
     80     → All the way down and press the + button
     81 ```
     82 
     83 ### Usage:
     84 
     85 1. Select some text. While the text is highlighted,
     86 2. press the keybinding assigned to the `clipboard-reader` executable to start
     87     the reading of the highlighted text.
     88 3. (optional, while `clipboard-speaker` is reading the text) Select some more
     89     text and press the keybinding that starts `clipboard-reader`. The selected
     90     text will be added to the text buffer and will be read right after the last
     91     bunch of text.
     92 4. (optional) GOTO 3.
     93 5. (optional) Press the other keybinding assigned to the `clipboard-reader-kill`
     94     script to make your computer stop speaking and clear the text buffer.
     95 
     96 ## Older shell version:
     97 
     98 ### Dependencies:
     99 
    100 * http://software.clapper.org/daemonize/
    101 * https://github.com/espeak-ng/espeak-ng/
    102 * https://github.com/kfish/xsel
    103 
    104 ### Installation:
    105 
    106 1. Install the dependencies:
    107     `apt install daemonize espeak-ng xsel`
    108 2. Copy the two executable scripts into your home bin directory:
    109     `cp clipboard-speaker clipboard-speaker-kill ~/bin/`
    110 3. Add the key bindings in:
    111     `Gnome Settings → Keyboard Shortcuts → All the way down and press the + button`
    112 
    113 ### Usage:
    114 
    115 1. Select some text.
    116 2. Press the keybinding to start `clipboard-reader`. Your computer is now speaking the stuff in the selection.
    117 3. (optional) Press the other keybinding to start `clipboard-reader-kill` and make computer stop speaking.
    118 
    119 [gcs]: https://codeberg.org/kakafarm/guile-clipboard-speaker/