1
1
# python-ivona-api
2
2
[ ![ Build status] ( https://img.shields.io/travis/Pythonity/python-ivona-api.svg )] [ travis ]
3
+ [ ![ Test coverage] ( https://img.shields.io/coveralls/Pythonity/python-ivona-api.svg )] [ coveralls ]
3
4
[ ![ PyPI version] ( https://img.shields.io/pypi/v/ivona_api.svg )] [ pypi ]
4
5
[ ![ Python versions] ( https://img.shields.io/pypi/pyversions/ivona_api.svg )] [ pypi ]
5
6
[ ![ 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,
12
13
as they should cover the vast majority of use cases. Lexicons endpoints
13
14
may be added in the future.
14
15
15
- If you're looking for out-of-the-box solution, have a look at
16
+ If you're looking for out-of-the-box solution, you should probably use
16
17
[ ivona-speak] [ ivona speak ] - it's a script that uses this library and lets you
17
18
use its functionality directly from your shell.
18
19
19
20
## Installation
20
21
With PyPI:
22
+
21
23
```
22
24
$ pip install ivona_api
23
25
```
24
26
25
27
## API
26
- There's no documentation as of now, but the code is commented and
27
- * should * be pretty straightforward to use.
28
+ There's no documentation as of now, but the code is commented and * should * be
29
+ pretty straightforward to use.
28
30
29
- But feel free to ask
[ me
] ( mailto:[email protected] ) if anything
31
+ That said - feel free to ask
[ me
] ( mailto:[email protected] ) if anything
30
32
is unclear.
31
33
32
34
## Tests
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
+ Package was tested with the help of ` py.test ` and ` tox ` on Python 2.7, 3.4, 3.5
36
+ and 3.6 (see ` tox.ini ` ).
35
37
36
38
To run tests yourself you need to set environment variables with secret
37
39
and access keys before running ` tox ` :
40
+
41
+ Code coverage is available at [ Coveralls] [ coveralls ] .
42
+
38
43
``` shell
44
+ $ pip install -r requirements/dev.txt
39
45
$ export IVONA_ACCESS_KEY=" YOUR_ACTUAL_ACCESS_KEY"
40
46
$ export IVONA_SECRET_KEY=" YOUR_ACTUAL_SECRET_KEY"
41
47
$ tox
@@ -45,14 +51,15 @@ $ tox
45
51
Package source code is available at [ GitHub] [ github ] .
46
52
47
53
Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements,
48
- add functionality and point out any mistakes.
54
+ add functionality and point out any mistakes. Thanks!
49
55
50
56
## Authors
51
57
Developed and maintained by [ Pythonity] [ pythonity ] .
52
58
53
59
Written by [ Paweł Adamczak] [ pawelad ] .
54
60
55
61
62
+ [ coveralls ] : https://coveralls.io/github/Pythonity/python-ivona-api
56
63
[ github ] : https://github.com/Pythonity/python-ivona-api
57
64
[ ivona keys ] : http://developer.ivona.com/en/speechcloud/introduction.html#Credentials
58
65
[ ivona speak ] : https://github.com/Pythonity/ivona-speak
0 commit comments