Skip to content

Commit e011f48

Browse files
committed
Updated README
1 parent 822c33b commit e011f48

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# python-ivona-api
2-
[![Build Status](https://img.shields.io/travis/Pythonity/python-ivona-api.svg)][ivona api travis]
3-
[![PyPI Version](https://img.shields.io/pypi/v/ivona_api.svg)][ivona api pypi]
4-
[![Python Versions](https://img.shields.io/pypi/pyversions/ivona_api.svg)][ivona api pypi]
2+
[![Build Status](https://img.shields.io/travis/Pythonity/python-ivona-api.svg)][travis]
3+
[![PyPI Version](https://img.shields.io/pypi/v/ivona_api.svg)][pypi]
4+
[![Python Versions](https://img.shields.io/pypi/pyversions/ivona_api.svg)][pypi]
55
[![License](https://img.shields.io/github/license/Pythonity/python-ivona-api.svg)][license]
66

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].
1010

1111
It currently only implements `CreateSpeech` and `ListVoices` endpoints,
1212
as they should cover the vast majority of use cases. Lexicons endpoints
1313
may be added in the future.
1414

1515
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
1717
library and lets you use its functionality directly from your shell.
1818

1919
## Installation
20-
With `PyPI`:
20+
With PyPI:
2121
```
22-
$ pip3 install ivona_api
22+
$ pip install ivona_api
2323
```
2424

2525
## API
@@ -30,33 +30,35 @@ But feel free to ask [me](mailto:[email protected]) if anything
3030
is unclear.
3131

3232
## 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`).
3535

3636
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`:
3838
```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
4142
```
4243

4344
## Contributions
44-
Package source code is available at [GitHub][ivona api github].
45+
Package source code is available at [GitHub][github].
4546

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.
4849

4950
## Authors
5051
Developed and maintained by [Pythonity][pythonity].
5152

5253
Written by [Paweł Adamczak][pawelad].
5354

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
5957
[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
6162
[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

Comments
 (0)