Merge pull request #139 from sergioteula/add-ruff-and-uv

Modernize tooling: migrate to Ruff, uv, and pyproject.toml

Author: sergioteula

.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

.coveragerc

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

.env.template

@@ -8,9 +8,9 @@ assignees: ''
 ---
 
 **Steps to reproduce**
-1. 
-2. 
-3. 
+1.
+2.
+3.
 
 **Code example**
 ```python

.flake8

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. 
+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.

.githooks/pre-push

@@ -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

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

@@ -0,0 +1,30 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Update version number
+        run: |
+          sed -i 's/version = ".*"/version = "${{ github.ref_name }}"/' pyproject.toml
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python -m build
+          twine upload dist/*