# Speechlight
[![Current Version on PyPi]][PyPi]
[![License]][License Page]
[![Supported Python Versions]][PyPi]
[![PyPi Downloads in Last 7 Days]][PyPi Download Stats]
[![PyPi Downloads in Last 30 Days]][PyPi Download Stats]
[![PyPi Total Downloads]][PyPi Download Stats]
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 [Mozilla Public License, version 2.0.][License Page]
Speechlight was originally created by [Nick Stockton.][Nick Stockton GitHub]
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-poetry.txt
poetry install --no-ansi
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-poetry.txt
poetry install --no-ansi
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)
```
[Current Version on PyPi]: https://img.shields.io/pypi/v/speechlight.svg
[License]: https://img.shields.io/github/license/nstockton/speechlight.svg
[License Page]: https://nstockton.github.io/speechlight/license (License Page)
[Supported Python Versions]: https://img.shields.io/pypi/pyversions/speechlight.svg
[PyPi]: https://pypi.org/project/speechlight (Speechlight on PyPi)
[PyPi Downloads in Last 7 Days]: https://pepy.tech/badge/speechlight/week
[PyPi Downloads in Last 30 Days]: https://pepy.tech/badge/speechlight/month
[PyPi Total Downloads]: https://pepy.tech/badge/speechlight
[PyPi Download Stats]: https://pepy.tech/project/speechlight (Download Statistics)
[Python]: https://python.org (Python Main Page)
[TTS]: https://en.wikipedia.org/wiki/Speech_synthesis (Speech Synthesis Wikipedia Page)
[screen reader]: https://en.wikipedia.org/wiki/Screen_reader (Screen Reader Wikipedia Page)
[API reference]: https://nstockton.github.io/speechlight/api (Speechlight API reference Page)
[Nick Stockton GitHub]: https://github.com/nstockton (My Profile On GitHub)
Raw data
{
"_id": null,
"home_page": "https://github.com/nstockton/speechlight",
"name": "speechlight",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "blind,braille,screen reader,tts,speech,accessibility,jaws,nvda,sapi,system access",
"author": "Nick Stockton",
"author_email": "nstockton@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/0a/41/581742c3cabb3c66135900354ef5bf4155f787b8b6e8cd7cc6564226419e/speechlight-1.8.0.tar.gz",
"platform": null,
"description": "# Speechlight\n\n[![Current Version on PyPi]][PyPi]\n[![License]][License Page]\n[![Supported Python Versions]][PyPi]\n[![PyPi Downloads in Last 7 Days]][PyPi Download Stats]\n[![PyPi Downloads in Last 30 Days]][PyPi Download Stats]\n[![PyPi Total Downloads]][PyPi Download Stats]\n\nA lightweight [Python][] library providing a common interface to multiple [TTS][] and [screen reader][] APIs. See the [API reference][] for more information.\n\n\n## License And Credits\n\nSpeechlight is licensed under the terms of the [Mozilla Public License, version 2.0.][License Page]\nSpeechlight was originally created by [Nick Stockton.][Nick Stockton GitHub]\nmacOS support by Jacob Schmude.\n\n\n## Installation\n\n```\npip install --user speechlight\n```\n\n\n## Running From Source\n\n### Windows-specific Instructions\n\nExecute the following commands from the root directory of this repository to install the virtual environment and project dependencies.\n```\npy -3 -m venv .venv\n.venv\\Scripts\\activate.bat\npip install --upgrade --require-hashes --requirement requirements-poetry.txt\npoetry install --no-ansi\npre-commit install -t pre-commit\npre-commit install -t pre-push\n```\n\n### Linux-specific Instructions\n\nExecute the following commands from the root directory of this repository to install the virtual environment and project dependencies.\n```\npython3 -m venv .venv\nsource .venv/bin/activate\npip install --upgrade --require-hashes --requirement requirements-poetry.txt\npoetry install --no-ansi\npre-commit install -t pre-commit\npre-commit install -t pre-push\n```\n\n\n## Example Usage\n\n```\nfrom speechlight import speech\n\n# Say something.\nspeech.say(\"Hello world!\")\n\n# Say something else, interrupting the currently speaking text.\nspeech.say(\"I'm a rood computer!\", interrupt=True)\n\n# Cancel the currently speaking message.\nspeech.silence()\n\n# Braille something.\nspeech.braille(\"Braille dots go bump in the night.\")\n\n# Speak and braille text at the same time.\nspeech.output(\"Read along with me.\")\n\n# And to interrupt speech.\nspeech.output(\"Rood!\", interrupt=True)\n```\n\n\n[Current Version on PyPi]: https://img.shields.io/pypi/v/speechlight.svg\n[License]: https://img.shields.io/github/license/nstockton/speechlight.svg\n[License Page]: https://nstockton.github.io/speechlight/license (License Page)\n[Supported Python Versions]: https://img.shields.io/pypi/pyversions/speechlight.svg\n[PyPi]: https://pypi.org/project/speechlight (Speechlight on PyPi)\n[PyPi Downloads in Last 7 Days]: https://pepy.tech/badge/speechlight/week\n[PyPi Downloads in Last 30 Days]: https://pepy.tech/badge/speechlight/month\n[PyPi Total Downloads]: https://pepy.tech/badge/speechlight\n[PyPi Download Stats]: https://pepy.tech/project/speechlight (Download Statistics)\n[Python]: https://python.org (Python Main Page)\n[TTS]: https://en.wikipedia.org/wiki/Speech_synthesis (Speech Synthesis Wikipedia Page)\n[screen reader]: https://en.wikipedia.org/wiki/Screen_reader (Screen Reader Wikipedia Page)\n[API reference]: https://nstockton.github.io/speechlight/api (Speechlight API reference Page)\n[Nick Stockton GitHub]: https://github.com/nstockton (My Profile On GitHub)\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "A lightweight Python library providing a common interface to multiple TTS and screen reader APIs.",
"version": "1.8.0",
"project_urls": {
"Documentation": "https://nstockton.github.io/speechlight",
"Homepage": "https://github.com/nstockton/speechlight",
"Repository": "https://github.com/nstockton/speechlight"
},
"split_keywords": [
"blind",
"braille",
"screen reader",
"tts",
"speech",
"accessibility",
"jaws",
"nvda",
"sapi",
"system access"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bcb89eab66f53c6b3697dba347f9de7245c9f692730e9692c639283ef019705",
"md5": "a0b87d5be1efd7eec296bfed4431151c",
"sha256": "52194bb7f250c9ef0037c3510c53172a408d296f19f8672da6c7af928cac73a7"
},
"downloads": -1,
"filename": "speechlight-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0b87d5be1efd7eec296bfed4431151c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 243156,
"upload_time": "2023-12-04T03:06:13",
"upload_time_iso_8601": "2023-12-04T03:06:13.787309Z",
"url": "https://files.pythonhosted.org/packages/8b/cb/89eab66f53c6b3697dba347f9de7245c9f692730e9692c639283ef019705/speechlight-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a41581742c3cabb3c66135900354ef5bf4155f787b8b6e8cd7cc6564226419e",
"md5": "79ff3eff9a6e5a160c99cb5ee02ff978",
"sha256": "0554dd15c3068d0f0937fd26f3841ce36df155bf46952d0f7d6439c1c9cd8b85"
},
"downloads": -1,
"filename": "speechlight-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "79ff3eff9a6e5a160c99cb5ee02ff978",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 324095,
"upload_time": "2023-12-04T03:06:15",
"upload_time_iso_8601": "2023-12-04T03:06:15.205716Z",
"url": "https://files.pythonhosted.org/packages/0a/41/581742c3cabb3c66135900354ef5bf4155f787b8b6e8cd7cc6564226419e/speechlight-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 03:06:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nstockton",
"github_project": "speechlight",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "speechlight"
}
JSON
