-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
# python-ivona-api | ||
[![Build status](https://img.shields.io/travis/Pythonity/python-ivona-api.svg)][travis] | ||
[![Test coverage](https://img.shields.io/coveralls/Pythonity/python-ivona-api.svg)][coveralls] | ||
[![PyPI version](https://img.shields.io/pypi/v/ivona_api.svg)][pypi] | ||
[![Python versions](https://img.shields.io/pypi/pyversions/ivona_api.svg)][pypi] | ||
[![License](https://img.shields.io/github/license/Pythonity/python-ivona-api.svg)][license] | ||
|
@@ -12,30 +13,35 @@ 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 | ||
If you're looking for out-of-the-box solution, you should probably use | ||
[ivona-speak][ivona speak] - it's a script that uses this library and lets you | ||
use its functionality directly from your shell. | ||
|
||
## Installation | ||
With PyPI: | ||
|
||
``` | ||
$ pip install ivona_api | ||
``` | ||
|
||
## API | ||
There's no documentation as of now, but the code is commented and | ||
*should* be pretty straightforward to use. | ||
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 | ||
That said - feel free to ask [me](mailto:[email protected]) if anything | ||
is unclear. | ||
|
||
## Tests | ||
Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4 | ||
and 3.5 (see `tox.ini`). | ||
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`). | ||
|
||
To run tests yourself you need to set environment variables with secret | ||
and access keys before running `tox`: | ||
|
||
Code coverage is available at [Coveralls][coveralls]. | ||
|
||
```shell | ||
$ pip install -r requirements/dev.txt | ||
$ export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY" | ||
$ export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY" | ||
$ tox | ||
|
@@ -45,14 +51,15 @@ $ tox | |
Package source code is available at [GitHub][github]. | ||
|
||
Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements, | ||
add functionality and point out any mistakes. | ||
add functionality and point out any mistakes. Thanks! | ||
|
||
## Authors | ||
Developed and maintained by [Pythonity][pythonity]. | ||
|
||
Written by [Paweł Adamczak][pawelad]. | ||
|
||
|
||
[coveralls]: https://coveralls.io/github/Pythonity/python-ivona-api | ||
[github]: https://github.com/Pythonity/python-ivona-api | ||
[ivona keys]: http://developer.ivona.com/en/speechcloud/introduction.html#Credentials | ||
[ivona speak]: https://github.com/Pythonity/ivona-speak | ||
|