Skip to content

Commit ae3a1e5

Browse files
committed
Updated readme
1 parent 0482395 commit ae3a1e5

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Amazon Product Advertising API 5.0 wrapper for Python
22

3-
A simple Python wrapper for the [last version of the Amazon Product Advertising API](https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html). This module allows interacting with Amazon using the official API in an easier way.
3+
A simple Python wrapper for the [last version of the Amazon Product Advertising
4+
API](https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html).
5+
This module allows interacting with Amazon using the official API in an easier way.
46

57
[![PyPI](https://img.shields.io/pypi/v/python-amazon-paapi?color=%231182C2&label=PyPI)](https://pypi.org/project/python-amazon-paapi/)
68
[![Python](https://img.shields.io/badge/Python->3.6-%23FFD140)](https://www.python.org/)
@@ -90,7 +92,8 @@ asin = get_asin('https://www.amazon.com/dp/B01N5IB20Q')
9092

9193
**Throttling:**
9294

93-
Throttling value represents the wait time in seconds between API calls, being the default value 1 second. Use it to avoid reaching Amazon request limits.
95+
Throttling value represents the wait time in seconds between API calls, being the
96+
default value 1 second. Use it to avoid reaching Amazon request limits.
9497

9598
```python
9699
amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=4) # Makes 1 request every 4 seconds
@@ -99,12 +102,20 @@ amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0) # No wait time betw
99102

100103
## Contribution
101104

102-
Activate githooks with:
105+
Creating pull requests for this repo is higly appreciated to add new features or solve
106+
bugs. To help during development process, githooks can be activated to run some scripts
107+
before pushing new commits. This will run checks for code format and tests, to ensure
108+
everything follows this repo guidelines. Use next command to activate them:
103109

104110
```
105111
git config core.hooksPath .githooks
106112
```
107113

114+
The same checks will also run on the repo with GitHub Actions to ensure all tests pass
115+
before merge.
116+
108117
## License
109118

110-
Copyright © 2021 Sergio Abad. See [license](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE) for details.
119+
Copyright © 2021 Sergio Abad. See
120+
[license](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE) for
121+
details.

0 commit comments

Comments
 (0)