python-amazon-paapi 5.0.0__tar.gz → 5.1.0__tar.gz

python_amazon_paapi-5.1.0/.agent/rules/code-style-guide.md

@@ -0,0 +1,27 @@
+---
+trigger: always_on
+---
+
+# General
+
+- All code in English
+- Add comments only when needed
+- Add docstrings for every function
+- Use type hints in all functions
+- Use f-strings
+- Follow PEP 8 and clean code principles
+- Imports always at the top
+- Avoid short variable names, abbreviations, or single-letter names
+- Avoid the use of noqa unless strictly necessary
+
+# Test
+
+- Add tests following TDD practices
+- Mirror the amazon_paapi structure in the tests directory
+- Use unittest.TestCase with setUp() and tearDown()
+- Use unittest assertions, not native assert
+- Use @patch decorators for mocks (avoid context managers)
+
+# References
+
+- Documentation for the Product Advertising API here: https://webservices.amazon.com/paapi5/documentation/operations.html

python_amazon_paapi-5.1.0/.env.template

@@ -0,0 +1,4 @@
+API_KEY=
+API_SECRET=
+AFFILIATE_TAG=
+COUNTRY_CODE=

python_amazon_paapi-5.1.0/.github/ISSUE_TEMPLATE/---bug-report.md

@@ -0,0 +1,23 @@
+---
+name: "\U0001F41B Bug Report"
+about: Report a reproducible bug or regression
+title: 'Bug: '
+labels: bug
+assignees: ''
+
+---
+
+**Steps to reproduce**
+1.
+2.
+3.
+
+**Code example**
+```python
+"Add some code that helps understanding the issue"
+```
+**Current behavior**
+A clear and concise description of what is currenctly happening.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.

python_amazon_paapi-5.1.0/.github/ISSUE_TEMPLATE/---feature-request.md

@@ -0,0 +1,20 @@
+---
+name: "\U0001F48E Feature request"
+about: Suggest an idea for this project
+title: 'Feature: '
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or code about the feature request here.

python_amazon_paapi-5.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+    - name: 🤔 Questions and Help
+      url: https://t.me/PythonAmazonPAAPI
+      about: This issue tracker is not for support questions. Please refer to our Telegram group for help or use the discussions section.

python_amazon_paapi-5.1.0/.github/workflows/check.yml

@@ -0,0 +1,94 @@
+name: Run linters and tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  pull-requests: read
+
+jobs:
+  changelog:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Check CHANGELOG was updated
+        run: |
+          if git diff --name-only origin/${{ github.base_ref }}...HEAD | grep -q "^CHANGELOG.md$"; then
+            echo "✅ CHANGELOG.md was updated"
+          else
+            echo "❌ ERROR: CHANGELOG.md was not updated"
+            echo "Please add your changes to the CHANGELOG.md file"
+            exit 1
+          fi
+
+  check:
+    runs-on: ubuntu-latest
+    env:
+      API_KEY: ${{ secrets.API_KEY }}
+      API_SECRET: ${{ secrets.API_SECRET }}
+      AFFILIATE_TAG: ${{ secrets.AFFILIATE_TAG }}
+      COUNTRY_CODE: ${{ secrets.COUNTRY_CODE }}
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install UV
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Cache UV dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/uv
+          key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-
+
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pre-commit-
+
+      - name: Run all checks
+        run: |
+          uv run pre-commit run --all-files
+
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install UV
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Cache UV dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/uv
+          key: ${{ runner.os }}-uv-py${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-py${{ matrix.python-version }}-
+
+      - name: Run tests
+        run: uv run --python "${{ matrix.python-version }}" pytest -rs --no-cov

python_amazon_paapi-5.1.0/.github/workflows/release.yml

@@ -0,0 +1,79 @@
+name: Create Release and Publish
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    environment: pypi
+    outputs:
+      version: ${{ steps.changelog.outputs.version }}
+      released: ${{ steps.check_tag.outputs.exists == 'false' }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Extract version and notes from CHANGELOG
+        id: changelog
+        run: |
+          # Extract version from first ## [x.x.x] header
+          VERSION=$(grep -m1 -oP '## \[\K[0-9]+\.[0-9]+\.[0-9]+' CHANGELOG.md)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+          # Extract release notes (content between first and second ## headers)
+          NOTES=$(awk '/^## \['"$VERSION"'\]/{flag=1; next} /^## \[/{flag=0} flag' CHANGELOG.md)
+
+          # Handle multiline output
+          {
+            echo "notes<<EOF"
+            echo "$NOTES"
+            echo "EOF"
+          } >> $GITHUB_OUTPUT
+
+      - name: Check if tag already exists
+        id: check_tag
+        run: |
+          if git rev-parse "v${{ steps.changelog.outputs.version }}" >/dev/null 2>&1; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create Release
+        if: steps.check_tag.outputs.exists == 'false'
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.changelog.outputs.version }}
+          name: v${{ steps.changelog.outputs.version }}
+          body: ${{ steps.changelog.outputs.notes }}
+          draft: false
+          prerelease: false
+
+      - name: Skip release (tag exists)
+        if: steps.check_tag.outputs.exists == 'true'
+        run: |
+          echo "⚠️ Tag v${{ steps.changelog.outputs.version }} already exists. Skipping release creation."
+          exit 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

python_amazon_paapi-5.1.0/.gitignore

@@ -0,0 +1,110 @@
+# Custom folders and files to ignore
+.vscode/
+.DS_Store
+coverage_html_report
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+uv.lock
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

python_amazon_paapi-5.1.0/.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+  python: python3.13
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.11
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: name-tests-test
+
+  - repo: https://github.com/lk16/detect-missing-init
+    rev: v0.1.6
+    hooks:
+      - id: detect-missing-init
+        args: ["--create", "--python-folders", "amazon_paapi"]
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.0
+    hooks:
+      - id: gitleaks
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.19.1"
+    hooks:
+      - id: mypy
+        exclude: sdk/
+
+  - repo: local
+    hooks:
+      - id: test
+        name: Running tests
+        language: system
+        entry: "bash -c 'set -a && source .env 2>/dev/null; set +a && uv run pytest -rs --cov=amazon_paapi'"
+        types_or: [python]
+        pass_filenames: false
+
+      - id: version-check
+        name: Check version consistency
+        language: system
+        entry: uv run python scripts/check_version.py
+        files: (CHANGELOG\.md|pyproject\.toml|docs/conf\.py)$
+        pass_filenames: false

python_amazon_paapi-5.1.0/.readthedocs.yml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+  - pdf
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

python_amazon_paapi-5.1.0/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [5.1.0] - 2026-01-11
+
+### Added
+
+- Integration tests with real Amazon API calls
+- Type hints throughout the codebase using `Literal` types for country codes
+- `.env.template` file for easier development setup
+- Code style guide for AI assistants (`.agent/rules/code-style-guide.md`)
+- Pre-commit hooks with Ruff integration
+- Version consistency check script (`scripts/check_version.py`)
+- Manual release workflow (`release.yml`) that creates GitHub releases from CHANGELOG
+- CI check to ensure CHANGELOG is updated in every PR
+
+### Changed
+
+- **BREAKING**: Minimum Python version raised from 3.7 to 3.9
+- Migrated from `setup.py` to `pyproject.toml` for project configuration
+- Replaced multiple linters (Flake8, isort, Black, Pylint) with Ruff
+- Replaced Docker-based development environment with `uv` package manager
+- Consolidated coverage, mypy, and pytest configuration into `pyproject.toml`
+- Renamed test files to use `_test.py` suffix instead of `test_` prefix
+- Updated GitHub Actions workflows to use `uv` instead of Docker
+- Improved docstrings across the codebase
+- Completely rewritten README with clearer structure and examples
+- Updated Read the Docs configuration to v2 format with modern Sphinx versions
+- Updated documentation to furo theme
+
+### Removed
+
+- `setup.py` - replaced by `pyproject.toml`
+- `.coveragerc` - configuration moved to `pyproject.toml`
+- `.flake8` - replaced by Ruff configuration in `pyproject.toml`
+- Docker development environment (`docker/`, `docker-compose.yml`)
+- Legacy shell scripts (`scripts/` directory)
+- Custom git hooks (`.githooks/`) - replaced by pre-commit

{python-amazon-paapi-5.0.0 → python_amazon_paapi-5.1.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Sergio Abad
+Copyright (c) 2026 Sergio Abad
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

python_amazon_paapi-5.1.0/Makefile

@@ -0,0 +1,29 @@
+export UID:=$(shell id -u)
+export GID:=$(shell id -g)
+
+export PYTHON_TAGS = 3.9 3.10 3.11 3.12 3.13 3.14 3.15
+
+setup:
+	@uv run pre-commit install
+
+test:
+	@touch .env
+	@uv run --env-file .env pytest -rs
+
+coverage:
+	@uv run pytest -rs --cov=amazon_paapi --cov-report=html --cov-report=term --cov-report=xml
+
+test-all-python-tags:
+	@touch .env
+	@for tag in $$PYTHON_TAGS; do \
+		uv run --env-file .env --python "$$tag" pytest -rs --no-cov; \
+	done
+
+lint:
+	@uv run ruff check --fix .
+
+mypy:
+	@uv run mypy .
+
+pre-commit:
+	@uv run pre-commit run -a

python_amazon_paapi-5.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: python-amazon-paapi
+Version: 5.1.0
+Summary: Amazon Product Advertising API 5.0 wrapper for Python
+Project-URL: Homepage, https://github.com/sergioteula/python-amazon-paapi
+Project-URL: Repository, https://github.com/sergioteula/python-amazon-paapi
+Author-email: Sergio Abad <sergio.abad@bytelix.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: affiliate,amazon,api,paapi,product-advertising-api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: certifi>=2023.0.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: six>=1.16.0
+Requires-Dist: urllib3<3,>=1.26.0
+Description-Content-Type: text/markdown
+
+# Python Amazon PAAPI
+
+A simple Python wrapper for the [Amazon Product Advertising API 5.0](https://webservices.amazon.com/paapi5/documentation/). Easily interact with Amazon's official API to retrieve product information, search for items, and more.
+
+[![PyPI](https://img.shields.io/pypi/v/python-amazon-paapi?color=%231182C2&label=PyPI)](https://pypi.org/project/python-amazon-paapi/)
+[![Python](https://img.shields.io/badge/Python-≥3.9-%23FFD140)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-MIT-%23e83633)](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE)
+[![Amazon API](https://img.shields.io/badge/Amazon%20API-5.0-%23FD9B15)](https://webservices.amazon.com/paapi5/documentation/)
+[![Downloads](https://img.shields.io/pypi/dm/python-amazon-paapi?label=Downloads)](https://pypi.org/project/python-amazon-paapi/)
+
+## Features
+
+- 🎯 **Simple object-oriented interface** for easy integration
+- 🔍 **Product search** by keywords, categories, or browse nodes
+- 📦 **Product details** via ASIN or Amazon URL
+- 🔄 **Item variations** support (size, color, etc.)
+- 🌍 **20+ countries** supported ([full list](https://github.com/sergioteula/python-amazon-paapi/blob/master/amazon_paapi/models/regions.py))
+- ⚡ **Batch requests** to get multiple items without the 10-item limit
+- 🛡️ **Built-in throttling** to avoid API rate limits
+- 📝 **Full type hints** for better IDE support
+
+## Installation
+
+```bash
+pip install python-amazon-paapi --upgrade
+```
+
+## Quick Start
+
+```python
+from amazon_paapi import AmazonApi
+
+# Initialize the API (get credentials from Amazon Associates)
+amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY)
+
+# Get product information by ASIN
+item = amazon.get_items('B01N5IB20Q')[0]
+print(item.item_info.title.display_value)
+```
+
+## Usage Examples
+
+### Get Multiple Products
+
+```python
+items = amazon.get_items(['B01N5IB20Q', 'B01F9G43WU'])
+for item in items:
+    print(item.images.primary.large.url)
+    print(item.offers.listings[0].price.amount)
+```
+
+### Use Amazon URL Instead of ASIN
+
+```python
+item = amazon.get_items('https://www.amazon.com/dp/B01N5IB20Q')
+```
+
+### Search Products
+
+```python
+results = amazon.search_items(keywords='nintendo switch')
+for item in results.items:
+    print(item.item_info.title.display_value)
+```
+
+### Get Product Variations
+
+```python
+variations = amazon.get_variations('B01N5IB20Q')
+for item in variations.items:
+    print(item.detail_page_url)
+```
+
+### Get Browse Node Information
+
+```python
+nodes = amazon.get_browse_nodes(['667049031', '599385031'])
+for node in nodes:
+    print(node.display_name)
+```
+
+### Extract ASIN from URL
+
+```python
+from amazon_paapi import get_asin
+
+asin = get_asin('https://www.amazon.com/dp/B01N5IB20Q')
+# Returns: 'B01N5IB20Q'
+```
+
+### Configure Throttling
+
+Control the wait time between API calls to avoid rate limits:
+
+```python
+# Wait 4 seconds between requests
+amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=4)
+
+# No throttling (use with caution)
+amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0)
+```
+
+## Documentation
+
+- 📖 [Full Documentation](https://python-amazon-paapi.readthedocs.io/)
+- 📋 [Changelog](https://github.com/sergioteula/python-amazon-paapi/blob/master/CHANGELOG.md)
+- 💬 [Telegram Support Group](https://t.me/PythonAmazonPAAPI)
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Install [uv](https://docs.astral.sh/uv/) package manager
+2. Clone and set up the project:
+
+```bash
+git clone https://github.com/sergioteula/python-amazon-paapi.git
+cd python-amazon-paapi
+uv sync
+uv run pre-commit install
+```
+
+3. Copy `.env.template` to `.env` and add your Amazon API credentials for integration tests.
+
+Pre-commit hooks will automatically run Ruff, mypy, and tests before each commit.
+
+## License
+
+MIT License © 2026 [Sergio Abad](https://github.com/sergioteula)