Metadata-Version: 2.0
Name: ivona-api
Version: 0.1.1
Summary: Python library that helps you connect to Amazon's IVONA Speech Cloud from within your Python project.
Home-page: https://github.com/Pythonity/python-ivona-api
Author: Paweł Adamczak
Author-email: pawel.adamczak@sidnet.info
License: MIT License
Download-URL: https://github.com/Pythonity/python-ivona-api/releases/latest
Keywords: amazon ivona api text to speech
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: requests (>=2.10.0)
Requires-Dist: requests-aws4auth (>=0.9)
Provides-Extra: testing
Requires-Dist: flaky; extra == 'testing'
Requires-Dist: pytest; extra == 'testing'

python-ivona-api
================

|Build Status| |PyPI Version| |PyPI Downloads| |Python Versions|
|License|

Python (3) library that helps you connect to Amazon's
`IVONA <https://www.ivona.com/>`__ Speech Cloud from within your Python
project. You need its `access
keys <http://developer.ivona.com/en/speechcloud/introduction.html#Credentials>`__
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 <https://github.com/Pythonity/ivona-speak>`__ - 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:pawel.adamczak@sidnet.info>`__ 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:

.. code:: shell

    export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY"
    export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY"

Contributions
-------------

Package source code is available at
`GitHub <https://github.com/Pythonity/python-ivona-api>`__.

Feel free to use, ask, fork, star, report bugs, fix them, suggest
enhancements and point out any mistakes.

Authors
-------

Developed and maintained by `Pythonity <http://pythonity.com/>`__.

Written by `Paweł Adamczak <https://github.com/pawelad>`__.

.. |Build Status| image:: https://img.shields.io/travis/Pythonity/python-ivona-api.svg
   :target: https://github.com/Pythonity/python-ivona-api
.. |PyPI Version| image:: https://img.shields.io/pypi/v/ivona_api.svg
   :target: https://pypi.python.org/pypi/ivona_api
.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/ivona_api.svg
   :target: https://pypi.python.org/pypi/ivona_api
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ivona_api.svg
   :target: https://pypi.python.org/pypi/ivona_api
.. |License| image:: https://img.shields.io/github/license/Pythonity/icon-font-to-png.svg
   :target: https://github.com/Pythonity/python-ivona-api/blob/master/LICENSE


