speechlight 2.0.1

A lightweight Python library providing a common interface to multiple TTS and screen reader APIs.

Speechlight

A lightweight Python library providing a common interface to multiple TTS and screen reader APIs. See the API reference for more information.

License And Credits

Speechlight is licensed under the terms of the MIT License. Speechlight was originally created by Nick Stockton. macOS support by Jacob Schmude.

Installation

pip install --user speechlight

Running From Source

Windows-specific Instructions

Execute the following commands from the root directory of this repository to install the virtual environment and project dependencies.

py -3 -m venv .venv
.venv\Scripts\activate.bat
pip install --upgrade --require-hashes --requirement requirements-uv.txt
uv sync
pre-commit install -t pre-commit
pre-commit install -t pre-push

Linux-specific Instructions

Execute the following commands from the root directory of this repository to install the virtual environment and project dependencies.

python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade --require-hashes --requirement requirements-uv.txt
uv sync
pre-commit install -t pre-commit
pre-commit install -t pre-push

Example Usage

from speechlight import speech

# Say something.
speech.say("Hello world!")

# Say something else, interrupting the currently speaking text.
speech.say("I'm a rood computer!", interrupt=True)

# Cancel the currently speaking message.
speech.silence()

# Braille something.
speech.braille("Braille dots go bump in the night.")

# Speak and braille text at the same time.
speech.output("Read along with me.")

# And to interrupt speech.
speech.output("Rood!", interrupt=True)