|
1 | 1 | # python-ivona-api |
2 | | -[][ivona api travis] |
3 | | -[][ivona api pypi] |
4 | | -[][ivona api pypi] |
| 2 | +[][travis] |
| 3 | +[][pypi] |
| 4 | +[][pypi] |
5 | 5 | [][license] |
6 | 6 |
|
7 | | -Python (3) library that helps you connect to Amazon's [IVONA][ivona] |
8 | | -Speech Cloud from within your Python project. You need its |
9 | | -[access keys][ivona keys] to use it. |
| 7 | +Python library that helps you connect to Amazon's [IVONA][ivona] Speech Cloud |
| 8 | +from within your Python project. All you need to use it are the |
| 9 | +[access keys][ivona keys]. |
10 | 10 |
|
11 | 11 | It currently only implements `CreateSpeech` and `ListVoices` endpoints, |
12 | 12 | as they should cover the vast majority of use cases. Lexicons endpoints |
13 | 13 | may be added in the future. |
14 | 14 |
|
15 | 15 | If you're looking for out-of-the-box solution, have a look at |
16 | | -[ivona-speak][ivona speak github] - it's a script that uses this very |
| 16 | +[ivona-speak][ivona speak] - it's a script that uses this very |
17 | 17 | library and lets you use its functionality directly from your shell. |
18 | 18 |
|
19 | 19 | ## Installation |
20 | | -With `PyPI`: |
| 20 | +With PyPI: |
21 | 21 | ``` |
22 | | -$ pip3 install ivona_api |
| 22 | +$ pip install ivona_api |
23 | 23 | ``` |
24 | 24 |
|
25 | 25 | ## API |
|
30 | 30 | is unclear. |
31 | 31 |
|
32 | 32 | ## Tests |
33 | | -Package was tested with `pytest` and `tox` on Python 3.4 |
34 | | -(see `tox.ini`). |
| 33 | +Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4 |
| 34 | +and 3.5 (see `tox.ini`). |
35 | 35 |
|
36 | 36 | To run tests yourself you need to set environment variables with secret |
37 | | -and access keys before running `tox` inside the repository: |
| 37 | +and access keys before running `tox`: |
38 | 38 | ```shell |
39 | | -export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY" |
40 | | -export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY" |
| 39 | +$ export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY" |
| 40 | +$ export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY" |
| 41 | +$ tox |
41 | 42 | ``` |
42 | 43 |
|
43 | 44 | ## Contributions |
44 | | -Package source code is available at [GitHub][ivona api github]. |
| 45 | +Package source code is available at [GitHub][github]. |
45 | 46 |
|
46 | | -Feel free to use, ask, fork, star, report bugs, fix them, suggest |
47 | | -enhancements and point out any mistakes. |
| 47 | +Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements, |
| 48 | +add functionality and point out any mistakes. |
48 | 49 |
|
49 | 50 | ## Authors |
50 | 51 | Developed and maintained by [Pythonity][pythonity]. |
51 | 52 |
|
52 | 53 | Written by [Paweł Adamczak][pawelad]. |
53 | 54 |
|
54 | | -[ivona api travis]: https://travis-ci.org/Pythonity/python-ivona-api |
55 | | -[ivona api github]: https://github.com/Pythonity/python-ivona-api |
56 | | -[ivona api pypi]: https://pypi.python.org/pypi/ivona_api |
57 | | -[license]: https://github.com/Pythonity/python-ivona-api/blob/master/LICENSE |
58 | | -[ivona]: https://www.ivona.com/ |
| 55 | + |
| 56 | +[github]: https://github.com/Pythonity/python-ivona-api |
59 | 57 | [ivona keys]: http://developer.ivona.com/en/speechcloud/introduction.html#Credentials |
60 | | -[ivona speak github]: https://github.com/Pythonity/ivona-speak |
| 58 | +[ivona speak]: https://github.com/Pythonity/ivona-speak |
| 59 | +[ivona]: https://www.ivona.com/ |
| 60 | +[license]: https://github.com/Pythonity/python-ivona-api/blob/master/LICENSE |
| 61 | +[pawelad]: https://github.com/pawelad |
61 | 62 | [pythonity]: http://pythonity.com/ |
62 | | -[pawelad]: https://github.com/pawelad |
| 63 | +[travis]: https://travis-ci.org/Pythonity/python-ivona-api |
| 64 | +[ypi]: https://pypi.python.org/pypi/ivona_api |
0 commit comments