First commit

Author: pawelad

.gitignore

@@ -0,0 +1,146 @@
+### pawelad ###
+.idea/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/dictionaries
+.idea/vcs.xml
+.idea/jsLibraryMappings.xml
+
+# Sensitive or high-churn files:
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+
+# Mongo Explorer plugin:
+.idea/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml

.travis.yml

@@ -0,0 +1,13 @@
+language: python
+
+matrix:
+    include:
+        - os: linux
+          python: 3.4
+          env: TOXENV=py34
+
+install:
+  - pip install tox --use-mirrors
+
+script:
+  - tox

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pythonity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,7 @@
+include *.md
+include *.txt
+include LICENSE
+include tox.ini
+recursive-include ivona_api *.mp3
+recursive-include ivona_api *.py
+recursive-include requirements *.txt

README.md

@@ -0,0 +1,57 @@
+# python-ivona-api
+Python (3) library that helps you connect to Amazon's [IVONA][ivona]
+Speech Cloud from within your Python project. You need its
+[access keys][ivona keys] to use it.
+
+It currently only implements `CreateSpeech` and `ListVoices` endpoints,
+as they should cover the vast majority of use cases. Lexicons endpoints
+may be added in the future.
+
+If you're looking for out-of-the-box solution, have a look at 
+[ivona-speak][ivona speak github] - it's a script that uses this very
+library and lets you use its functionality directly from your shell.
+
+Packages required for running and testing are listed in `requirements`
+directory.
+
+## Installation
+With `pip`:
+```
+$ pip3 install ivona_api
+```
+
+## API
+There's no documentation as of now, but the code is commented and
+*should* be pretty straightforward to use.
+
+But feel free to ask [me](mailto:[email protected]) if anything
+is unclear.
+
+## Tests
+Package was tested with `pytest` and `tox` on Python 3.4
+(see `tox.ini`).
+
+To run tests yourself you need to set environment variables with secret
+and access keys before running `tox` inside the repository:
+```
+export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY"
+export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY"
+```
+
+## Contributions
+Package source code is available at [GitHub][ivona api github].
+
+Feel free to use, ask, fork, star, report bugs, fix them, suggest 
+enhancements and point out any mistakes.
+
+## Authors
+Developed and maintained by [Pythonity][pythonity].
+
+Written by [Paweł Adamczak][pawelad].
+
+[ivona]: https://www.ivona.com/
+[ivona keys]: http://developer.ivona.com/en/speechcloud/introduction.html#Credentials
+[ivona speak github]: https://github.com/Pythonity/ivona-speak
+[ivona api github]: https://github.com/Pythonity/python-ivona-api
+[pythonity]: http://pythonity.com/
+[pawelad]: https://github.com/pawelad

ivona_api/__init__.py

@@ -0,0 +1,141 @@
+from urllib.parse import urljoin
+
+import requests
+from requests_aws4auth import AWS4Auth
+
+
+IVONA_REGION_ENDPOINTS = {
+    'eu-west-1': 'https://tts.eu-west-1.ivonacloud.com',  # EU, Dublin
+    'us-east-1': 'https://tts.us-east-1.ivonacloud.com',  # US East, N. Virginia
+    'us-west-2': 'https://tts.us-west-2.ivonacloud.com',  # US West, Oregon
+}
+
+
+class IvonaAPI:
+    """
+    Base class that for accessing Ivona web API.
+    Currently implements 'CreateSpeech' and 'ListVoices' endpoints, without
+    support for lexicon actions.
+    """
+    ALLOWED_CODECS = ['ogg', 'mp3', 'mp4']
+
+    @property
+    def region(self):
+        return self._region
+
+    @region.setter
+    def region(self, value):
+        if value not in IVONA_REGION_ENDPOINTS.keys():
+            raise ValueError("Incorrect region: {}".format(value))
+        self._region = value
+
+    @property
+    def codec(self):
+        return self._codec
+
+    @codec.setter
+    def codec(self, value):
+        if value.lower() not in self.ALLOWED_CODECS:
+            raise ValueError("Incorrect codec - only ogg, mp3 and mp4 allowed.")
+        self._codec = value
+
+    def __init__(self, access_key, secret_key, voice_name='Salli',
+                 language='en-US', codec='mp3', region='eu-west-1'):
+        self.region = region
+        self._aws4auth = AWS4Auth(access_key, secret_key, region, 'tts')
+
+        self.available_voices = self.get_available_voices()
+        self.set_voice(voice_name, language)
+
+        self.codec = codec.lower()
+
+        # Below are listed additional parameters that have default values,
+        # but are initialized here so that they can be changed on instance
+        # basis if need be
+
+        # ['x-slow', 'slow', 'medium', 'fast', 'x-fast', 'default']
+        self.rate = 'default'
+        # ['silent', 'x-soft', 'soft', 'medium', 'loud', 'x-loud', 'default']
+        self.volume = 'default'
+        # Integer in the range of 0-3000 (in milliseconds)
+        self.sentence_break = 400
+        # Integer in the range of 0-5000 (in milliseconds)
+        self.paragraph_break = 650
+
+    def _check_if_voice_exists(self, voice_name, language):
+        if not any([v['Name'] == voice_name and v['Language'] == language
+                    for v in self.available_voices]):
+            return False
+        else:
+            return True
+
+    def set_voice(self, voice_name, language):
+        """Make sure that passed voice name and language pair exists"""
+        if not self._check_if_voice_exists(voice_name, language):
+            raise ValueError("Incorrect voice name-language pair.")
+        self._voice_name = voice_name
+        self._language = language
+
+    def get_available_voices(self):
+        """
+        Returns a list of available voices, via 'ListVoices' endpoint
+            http://developer.ivona.com/en/speechcloud/actions.html#ListVoices
+        """
+        endpoint = urljoin(
+            IVONA_REGION_ENDPOINTS[self.region], 'ListVoices',
+        )
+        r = requests.get(endpoint, auth=self._aws4auth)
+
+        if 'x-amzn-ErrorType' in r.headers:
+            raise IvonaAPIException(r.headers['x-amzn-ErrorType'])
+
+        return r.json()['Voices']
+
+    def text_to_speech(self, text, file, voice_name=None, language=None):
+        """
+        Saves given text synthesized audio file, via 'CreateSpeech' endpoint
+            http://developer.ivona.com/en/speechcloud/actions.html#CreateSpeech
+        """
+        if voice_name or language:
+            if not self._check_if_voice_exists(voice_name, language):
+                raise ValueError("Incorrect voice name-language pair.")
+        else:
+            voice_name = self._voice_name
+            language = self._language
+
+        endpoint = urljoin(
+            IVONA_REGION_ENDPOINTS[self.region], 'CreateSpeech',
+        )
+
+        data = {
+            'Input': {
+                'Data': str(text),
+            },
+            'OutputFormat': {
+                'Codec': self.codec.upper(),
+            },
+            'Parameters': {
+                'Rate': self.rate,
+                'Volume': self.volume,
+                'SentenceBreak': self.sentence_break,
+                'ParagraphBreak': self.paragraph_break,
+            },
+            'Voice': {
+                'Name': voice_name,
+                'Language': language,
+            },
+        }
+
+        r = requests.post(endpoint, auth=self._aws4auth, json=data)
+
+        if 'x-amzn-ErrorType' in r.headers:
+            raise IvonaAPIException(r.headers['x-amzn-ErrorType'])
+
+        file.write(r.content)
+
+        return True
+
+
+class IvonaAPIException(Exception):
+    """Base IvonaAPI exception"""
+    pass