Skip to content

Commit a771246

Browse files
committed
updated documentation
1 parent 6a8ac16 commit a771246

File tree

3 files changed

+23
-11
lines changed

3 files changed

+23
-11
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ for item in items:
5050
print(item.offers.listings[0].price.amount) # Current price
5151
```
5252

53-
**Use URL insted of ASIN:**
53+
**Use URL instead of ASIN:**
5454

5555
```python
5656
item = amazon.get_items('https://www.amazon.com/dp/B01N5IB20Q')
@@ -99,17 +99,29 @@ amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0) # No wait time betw
9999

100100
## Contribution
101101

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

105+
1. Install [uv](https://docs.astral.sh/uv/) package manager
106+
2. Clone the repository and install dependencies:
107+
108+
```bash
109+
git clone https://github.com/sergioteula/python-amazon-paapi.git
110+
cd python-amazon-paapi
111+
uv sync
107112
```
108-
git config core.hooksPath .githooks
113+
114+
3. Set up pre-commit hooks:
115+
116+
```bash
117+
uv run pre-commit install
109118
```
110119

111-
The same checks will also run on the repo with GitHub Actions to ensure all tests pass
112-
before merge.
120+
4. Copy `.env.template` to `.env` and fill in your Amazon API credentials for integration tests.
121+
122+
The pre-commit hooks will run Ruff (linting and formatting), mypy (type checking), and
123+
tests before each commit. The same checks will also run on the repo with GitHub Actions
124+
to ensure all tests pass before merge.
113125

114126
## License
115127

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
# -- Project information -----------------------------------------------------
2020

2121
project = "python-amazon-paapi"
22-
copyright = "2021, Sergio Abad"
22+
copyright = "2026, Sergio Abad"
2323
author = "Sergio Abad"
2424

2525
# The full version, including alpha/beta/rc tags
26-
release = "4.2.0"
26+
release = "5.1.0"
2727

2828

2929
# -- General configuration ---------------------------------------------------

docs/pages/usage-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ for item in items:
2424
print(item.offers.listings[0].price.amount) # Current price
2525
```
2626

27-
**Use URL insted of ASIN:**
27+
**Use URL instead of ASIN:**
2828

2929
```python
3030
item = amazon.get_items('https://www.amazon.com/dp/B01N5IB20Q')

0 commit comments

Comments
 (0)