Metadata-Version: 2.0
Name: ivona-api
Version: 0.3.0
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: requests (>=2.18.1)
Requires-Dist: requests-aws4auth (>=0.9)
Requires-Dist: six (>=1.10.0)
Provides-Extra: testing
Requires-Dist: pytest; extra == 'testing'

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

|Build status| |Test coverage| |PyPI version| |Python versions|
|License|

Python library that helps you connect to Amazon's
`IVONA <https://www.ivona.com/>`__ Speech Cloud from within your Python
project. All you need to use it are the `access
keys <http://developer.ivona.com/en/speechcloud/introduction.html#Credentials>`__.

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, you should probably use
`ivona-speak <https://github.com/Pythonity/ivona-speak>`__ - it's a
script that uses this library and lets you use its functionality
directly from your shell.

Installation
------------

>From PyPI:

::

    $ pip install ivona_api

API
---

There's no proper documentation as of now, but the code is commented and
*should* be pretty straightforward to use.

That said - feel free to open a `GitHub
issues <https://github.com/Pythonity/python-ivona-api/issues/new>`__ if
anything is unclear.

Tests
-----

Package was tested with the help of ``py.test`` and ``tox`` on Python
2.7, 3.4, 3.5 and 3.6 (see ``tox.ini``).

Code coverage is available at
`Coveralls <https://coveralls.io/github/Pythonity/python-ivona-api>`__.

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='...'
    $ export IVONA_SECRET_KEY='...'
    $ pip install tox
    $ tox

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, add functionality and point out any mistakes. Thanks!

Authors
-------

Developed and maintained by `Pythonity <https://pythonity.com/>`__, a
group of Python enthusiasts who love open source, have a neat
`blog <http://blog.pythonity.com/>`__ and are available `for
hire <https://pythonity.com/>`__.

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

Released under `MIT
License <https://github.com/Pythonity/python-ivona-api/blob/master/LICENSE>`__.

.. |Build status| image:: https://img.shields.io/travis/Pythonity/python-ivona-api.svg
   :target: https://travis-ci.org/Pythonity/python-ivona-api
.. |Test coverage| image:: https://img.shields.io/coveralls/Pythonity/python-ivona-api.svg
   :target: https://coveralls.io/github/Pythonity/python-ivona-api
.. |PyPI version| image:: https://img.shields.io/pypi/v/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/python-ivona-api.svg
   :target: https://github.com/Pythonity/python-ivona-api/blob/master/LICENSE


