espeakng


Nameespeakng JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://sayak-brm.github.io/espeakng-python/
SummaryAn eSpeak NG TTS binding for Python3
upload_time2024-02-05 16:23:15
maintainer
docs_urlNone
authorSayak B
requires_python>=3.9
license
keywords tts espeak speakng espeakng speech
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # eSpeak NG TTS Bindings for Python3

Copyright 2016-2020 [Sayak B](https://sayakb.com/). Licenced under
[GNU GPLv3](https://opensource.org/licenses/GPL-3.0).

[![Python Version](https://img.shields.io/badge/Python-3-brightgreen.svg)](https://www.python.org/download/releases/3.0/)
![Linux](https://img.shields.io/badge/-Linux-brightgreen.svg)
![Windows](https://img.shields.io/badge/-Windows-brightgreen.svg)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsayak-brm%2Fespeakng-python.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsayak-brm%2Fespeakng-python?ref=badge_shield)

## Requirements

You need to have eSpeak NG installed in your system and added to the path.

### Windows

The latest installers for eSpeak NG can be found [here](https://github.com/espeak-ng/espeak-ng/releases/latest).

The installed executable may need to be added to the system path.
([See here](https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/))

### Ubuntu & Debian

```bash
sudo apt-get update
sudo apt-get install espeak-ng
```

### Others

If eSpeak NG is not available in your package manager, you may need to compile
the binaries for your system. Refer to
[this page](https://github.com/espeak-ng/espeak-ng/blob/master/docs/building.md)
for more information.

## Installation

### PyPi

This library is available on [PyPi](https://pypi.org/project/espeakng/).

```sh
pip install espeakng
```

### GitHub Releases

You can download the latest release for this library [here](https://github.com/sayak-brm/espeakng-python/releases/latest).

## Usage

First, we have to initialize a `Speaker`.

```python
import espeakng

mySpeaker = espeakng.Speaker()
```

And then use the `Speaker.say()` method to speak:

```python
mySpeaker.say('Hello, World!')
```

Calling `Speaker.say()` will interrupt any ongoing output from the same object
immediately.

Use the following code if you wish to wait for any ongoing speech to complete:

```python
mySpeaker.say('I am a demo of the say() method.', wait4prev=True)
```

---

### Changing speech properties

#### Pitch

By default the pitch is set at 80.

Change it by:

```python
mySpeaker.pitch = 120
```

#### Words per Minute (WPM)

By default WPM is set at 120.

Change it by:

```python
mySpeaker.wpm = 140
```

#### Voice

By default the voice is set to 'en'. The complete list of supported voices can
be found
[here](https://github.com/espeak-ng/espeak-ng/blob/master/docs/languages.md).

Change it by:

```python
mySpeaker.voice = 'es'
```

#### Export to .WAV file

By default, your text will just be spoken aloud, but if you want it to be written to a .WAV file, you can specify an `export_path` when calling the `say` function, as seen below:

```python
mySpeaker.say("Export this to a file", export_path="test.wav")
```

## Special thanks

- [MickeyDelp](https://github.com/MickeyDelp) for wordgap and amplitude controls, and other helper methods.
- [FlorianEagox](https://github.com/FlorianEagox) for the export to WAV file feature.

            

Raw data

            {
    "_id": null,
    "home_page": "https://sayak-brm.github.io/espeakng-python/",
    "name": "espeakng",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "tts,espeak,speakng,espeakng,speech",
    "author": "Sayak B",
    "author_email": "me@sayakb.com",
    "download_url": "https://files.pythonhosted.org/packages/4a/78/73dc36a1c03d38f9ada0374baa8eeaf04cc0853b67a3517b1fb9d091d72b/espeakng-1.0.3.tar.gz",
    "platform": null,
    "description": "# eSpeak NG TTS Bindings for Python3\n\nCopyright 2016-2020 [Sayak B](https://sayakb.com/). Licenced under\n[GNU GPLv3](https://opensource.org/licenses/GPL-3.0).\n\n[![Python Version](https://img.shields.io/badge/Python-3-brightgreen.svg)](https://www.python.org/download/releases/3.0/)\n![Linux](https://img.shields.io/badge/-Linux-brightgreen.svg)\n![Windows](https://img.shields.io/badge/-Windows-brightgreen.svg)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsayak-brm%2Fespeakng-python.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsayak-brm%2Fespeakng-python?ref=badge_shield)\n\n## Requirements\n\nYou need to have eSpeak NG installed in your system and added to the path.\n\n### Windows\n\nThe latest installers for eSpeak NG can be found [here](https://github.com/espeak-ng/espeak-ng/releases/latest).\n\nThe installed executable may need to be added to the system path.\n([See here](https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/))\n\n### Ubuntu & Debian\n\n```bash\nsudo apt-get update\nsudo apt-get install espeak-ng\n```\n\n### Others\n\nIf eSpeak NG is not available in your package manager, you may need to compile\nthe binaries for your system. Refer to\n[this page](https://github.com/espeak-ng/espeak-ng/blob/master/docs/building.md)\nfor more information.\n\n## Installation\n\n### PyPi\n\nThis library is available on [PyPi](https://pypi.org/project/espeakng/).\n\n```sh\npip install espeakng\n```\n\n### GitHub Releases\n\nYou can download the latest release for this library [here](https://github.com/sayak-brm/espeakng-python/releases/latest).\n\n## Usage\n\nFirst, we have to initialize a `Speaker`.\n\n```python\nimport espeakng\n\nmySpeaker = espeakng.Speaker()\n```\n\nAnd then use the `Speaker.say()` method to speak:\n\n```python\nmySpeaker.say('Hello, World!')\n```\n\nCalling `Speaker.say()` will interrupt any ongoing output from the same object\nimmediately.\n\nUse the following code if you wish to wait for any ongoing speech to complete:\n\n```python\nmySpeaker.say('I am a demo of the say() method.', wait4prev=True)\n```\n\n---\n\n### Changing speech properties\n\n#### Pitch\n\nBy default the pitch is set at 80.\n\nChange it by:\n\n```python\nmySpeaker.pitch = 120\n```\n\n#### Words per Minute (WPM)\n\nBy default WPM is set at 120.\n\nChange it by:\n\n```python\nmySpeaker.wpm = 140\n```\n\n#### Voice\n\nBy default the voice is set to 'en'. The complete list of supported voices can\nbe found\n[here](https://github.com/espeak-ng/espeak-ng/blob/master/docs/languages.md).\n\nChange it by:\n\n```python\nmySpeaker.voice = 'es'\n```\n\n#### Export to .WAV file\n\nBy default, your text will just be spoken aloud, but if you want it to be written to a .WAV file, you can specify an `export_path` when calling the `say` function, as seen below:\n\n```python\nmySpeaker.say(\"Export this to a file\", export_path=\"test.wav\")\n```\n\n## Special thanks\n\n- [MickeyDelp](https://github.com/MickeyDelp) for wordgap and amplitude controls, and other helper methods.\n- [FlorianEagox](https://github.com/FlorianEagox) for the export to WAV file feature.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "An eSpeak NG TTS binding for Python3",
    "version": "1.0.3",
    "project_urls": {
        "Homepage": "https://sayak-brm.github.io/espeakng-python/"
    },
    "split_keywords": [
        "tts",
        "espeak",
        "speakng",
        "espeakng",
        "speech"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5fd25e124c0ee5784fbf584765e07e6e90ceaedf18b7d59b5c4c7840f20db10",
                "md5": "3c5aacbf4c13baab3f1d59311b77e261",
                "sha256": "1199e7c1fa0ee3c3c6a0b68170ec2a8659ded1815794188de267fdee33d18df4"
            },
            "downloads": -1,
            "filename": "espeakng-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3c5aacbf4c13baab3f1d59311b77e261",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 16871,
            "upload_time": "2024-02-05T16:23:14",
            "upload_time_iso_8601": "2024-02-05T16:23:14.472780Z",
            "url": "https://files.pythonhosted.org/packages/e5/fd/25e124c0ee5784fbf584765e07e6e90ceaedf18b7d59b5c4c7840f20db10/espeakng-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a7873dc36a1c03d38f9ada0374baa8eeaf04cc0853b67a3517b1fb9d091d72b",
                "md5": "54256d0bb99231305a6e0c7d210afa24",
                "sha256": "b07f464cdca968516a0dfcc171c587d522ba366fcc4cb5e0efbda2f3e2a1bd05"
            },
            "downloads": -1,
            "filename": "espeakng-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "54256d0bb99231305a6e0c7d210afa24",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 16400,
            "upload_time": "2024-02-05T16:23:15",
            "upload_time_iso_8601": "2024-02-05T16:23:15.612179Z",
            "url": "https://files.pythonhosted.org/packages/4a/78/73dc36a1c03d38f9ada0374baa8eeaf04cc0853b67a3517b1fb9d091d72b/espeakng-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 16:23:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "espeakng"
}
        
Elapsed time: 4.18735s