Metadata-Version: 2.4
Name: pyespeakr
Version: 1.0.0
Summary: Simple Python wrapper for eSpeak TTS engine
Author: Rimten1379_py
License: MIT
Project-URL: Homepage, https://github.com/nahafiasas-codes/pyespeakr
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

📦 pyespeakr (example documentation)

Overview

pyespeakr is a lightweight Python wrapper around the espeak speech synthesis engine.
It allows you to easily convert text into speech, read text files aloud, and save spoken audio to a file using simple Python functions.

It is designed for Linux/Termux environments where espeak is installed.


---

⚙️ Requirements

Python 3.7+

espeak installed on system


Install espeak (Linux / Termux):

sudo apt install espeak


---

🚀 Installation

If published on PyPI:

pip install pyespeakr


---

📌 Features

Text-to-speech (say)

Read text files aloud (open_file)

Save speech to audio file (save_to_file)

Adjustable voice, speed, volume, and pitch



---

🔊 Usage

1. Speak text

import pyespeakr

pyespeakr.say("Hello world")


---

2. Change voice settings

pyespeakr.say(
    "Hello from Python",
    voice="en+m3",
    speed=180,
    volume=100,
    pitch=60
)


---

3. Read and speak a file

pyespeakr.open_file("text.txt")

With custom settings:

pyespeakr.open_file(
    "text.txt",
    speed=160,
    voice="en+m3"
)


---

4. Save speech to audio file

pyespeakr.save_to_file(
    "This will be saved as audio",
    "output.wav"
)


---

⚙️ Parameters

Common parameters

Parameter	Type	Default	Description

voice	str	"en+m3"	Speech voice
speed	int	175	Speech speed
volume	int	100	Audio volume
pitch	int	50	Voice pitch



---

📁 Functions

say(data, **kwargs)

Speak text directly using espeak.

open_file(path, **kwargs)

Reads a text file and speaks its content.

save_to_file(data, name, **kwargs)

Converts text to speech and saves it as an audio file.


---

🔢 Version

version = "1.0.0"


---

🧪 Example Full Program

import pyespeakr

pyespeakr.say("Testing the module")

pyespeakr.save_to_file(
    "Hello, this is a test file",
    "test.wav",
    speed=160
)


---

⚠️ Notes

Requires espeak installed on system

Works best on Linux / Termux environments

Windows may require additional setup
