A Flask extension to help in generating Google Text-To-Speech files.
Project description
Flask-gTTS
A Flask extension to add support for Google Text-To-Speech (TTS).
Install:
- With pip
pip install Flask-gTTS
- From the source:
git clone https://github.com/mrf345/flask_gtts.gitcd flask_gttspython setup.py install
Setup:
- Inside the Flask app:
from flask import Flask, render_template
from flask_gtts import gtts
app = Flask(__name__)
gtts(app)
- Inside the jinja template:
{% block content %}
<audio src="{{ sayit(text='Hello from Flask !')}}"></audio>
{% endblock %}
- Dynamic read TTS example:
<head>
{{ read(id='.readIt') }}
</head>
<body>
<h1 class='readIt'>Say something</h1>
<h1 class='readIT' language='it'>qualcosa da dire</h1>
</body>
- Dynamic route example:
from flask import Flask
from flask_gtts import gtts
# If we want to allow only logged in users for example.
from flask_login import login_required
app = Flask(__name__)
gtts(app,
route=True,
route_decorator=login_required,
route_path='/gtts')
And now you can test the endpoint by accessing http://localhost:5000/gtts/en-us/some text to test. It will return JSON response:
{
"mp3": "Generated audio file path."
}
Settings:
gtts()options:
def __init__(self, app=None, temporary=True, tempdir='flask_gtts', route=False,
route_path='/gtts', route_decorator=None):
'''Extension to help in generating Google Text-To-Speech files.
Parameters
----------
app : Flask Application, optional
Flask application instance, by default None
temporary : bool, optional
Remove the audio files before existing, by default True
tempdir : str, optional
Name of the static directory to store audio files in, by default 'flask_gtts'
route : bool, optional
Enable endpoint to generate TTS file dynamically, by default False
route_path : str, optional
Endpoint route path, by default '/gtts'
route_decorator : callable, optional
Decorator to wrap route endpoint, by default None
failsafe : bool, optional
Failsafe or throw exceptions, by default False
'''
sayit()options:
def say(self, lang='en-us', text='Flask says Hi!'):
'''Generate a TTS audio file.
Parameters
----------
lang : str, optional
Language to produce the TTS in, by default 'en-us'
text : str, optional
Text to convert into audio, by default 'Flask says Hi!'
Returns
-------
str
Relative url of the generated TTS audio file.
'''
read()options:
def read(self, id='.toRead', mouseover=False):
'''Read an HTML element inner text.
Parameters
----------
id : str, optional
HTML element css selector, by default '.toRead'
mouseover : bool, optional
Read text on `mouseover` event instead of `click`, by default False
Returns
-------
str
Safe JavaScript to read an HTML element content.
'''
- List of supported languages:
'af' : 'Afrikaans' 'sq' : 'Albanian' 'ar' : 'Arabic' 'hy' : 'Armenian' 'bn' : 'Bengali' 'ca' : 'Catalan' 'zh' : 'Chinese' 'zh-cn' : 'Chinese (Mandarin/China)' 'zh-tw' : 'Chinese (Mandarin/Taiwan)' 'zh-yue' : 'Chinese (Cantonese)' 'hr' : 'Croatian' 'cs' : 'Czech' 'da' : 'Danish' 'nl' : 'Dutch' 'en' : 'English' 'en-au' : 'English (Australia)' 'en-uk' : 'English (United Kingdom)' 'en-us' : 'English (United States)' 'eo' : 'Esperanto' 'fi' : 'Finnish' 'fr' : 'French' 'de' : 'German' 'el' : 'Greek' 'hi' : 'Hindi' 'hu' : 'Hungarian' 'is' : 'Icelandic' 'id' : 'Indonesian' 'it' : 'Italian' 'ja' : 'Japanese' 'km' : 'Khmer (Cambodian)' 'ko' : 'Korean' 'la' : 'Latin' 'lv' : 'Latvian' 'mk' : 'Macedonian' 'no' : 'Norwegian' 'pl' : 'Polish' 'pt' : 'Portuguese' 'ro' : 'Romanian' 'ru' : 'Russian' 'sr' : 'Serbian' 'si' : 'Sinhala' 'sk' : 'Slovak' 'es' : 'Spanish' 'es-es' : 'Spanish (Spain)' 'es-us' : 'Spanish (United States)' 'sw' : 'Swahili' 'sv' : 'Swedish' 'ta' : 'Tamil' 'th' : 'Thai' 'tr' : 'Turkish' 'uk' : 'Ukrainian' 'vi' : 'Vietnamese' 'cy' : 'Welsh'
Credit:
- gTTS: Python Google text-to-speech
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Flask_gTTS-0.17-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 80150241cb3505a4a5e3866f5d16588a6ed6dc082032f3bb147fb998a2088103 |
|
| MD5 | 2022644afb2ac11bea5525223f848ed0 |
|
| BLAKE2b-256 | e3c0c795325e3adac3aee440fe2ef6af506ab62fad66e53d3c8e1a6f29afcd97 |
