Merge pull request #277 from cyberjunky/revamp

Revamped API code and enhanced example/demo code

Author: cyberjunky

.coderabbit.yaml

@@ -2,21 +2,32 @@
 language: "en-US"
 early_access: true
 reviews:
-  profile: "assertive"
-  request_changes_workflow: false
+  profile: "pythonic"
+  request_changes_workflow: true
   high_level_summary: true
   poem: false
   review_status: true
   collapse_walkthrough: false
   auto_review:
     enabled: true
     drafts: false
+  auto_fix:
+    enabled: true
+    include_imports: true
+    include_type_hints: true
+    include_security_fixes: true
   path_filters:
     - "!tests/**/cassettes/**"
   path_instructions:
     - path: "tests/**"
       instructions: |
         - test functions shouldn't have a return type hint
         - it's ok to use `assert` instead of `pytest.assume()`
+    - path: "garminconnect/**"
+      instructions: |
+        - prefer modern Python patterns (3.10+)
+        - use type hints consistently
+        - follow PEP 8 and modern Python conventions
+        - suggest performance improvements where applicable
 chat:
   auto_reply: true

.editorconfig

@@ -0,0 +1,28 @@
+# EditorConfig configuration for code consistency
+# https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 88
+
+[*.py]
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.{js,json}]
+indent_size = 2
+
+[*.toml]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

.github/dependabot.yml

@@ -4,9 +4,13 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: daily
+      time: "20:00"
+      timezone: "Europe/Amsterdam"
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: daily
+      time: "20:00"
+      timezone: "Europe/Amsterdam"

.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+"on":
+  push:
+    branches:
+      - main
+      - master
+      - revamp
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pdm
+          pdm install --group :all
+
+      - name: Lint with ruff
+        run: |
+          pdm run ruff check .
+
+      - name: Format check with black
+        run: |
+          pdm run black --check .
+
+      - name: Type check with mypy
+        run: |
+          pdm run mypy garminconnect --ignore-missing-imports
+
+      # - name: Test with pytest
+      #   env:
+      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
+      #   run: |
+      #     # Use existing VCR cassettes for CI to avoid network calls
+      #     pdm run pytest tests/ -v --tb=short --vcr-record=none
+      #   continue-on-error: false
+
+      # - name: Upload coverage reports
+      #   if: matrix.python-version == '3.11'
+      #   env:
+      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
+      #   run: |
+      #     pdm run coverage run -m pytest -v --tb=short --vcr-record=none
+      #     pdm run coverage xml
+      #   continue-on-error: true
+
+      - name: Upload coverage artifact
+        if: matrix.python-version == '3.11'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-xml
+          path: coverage.xml
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install bandit[toml] safety
+
+      - name: Security check with bandit
+        run: |
+          bandit -r garminconnect -f json -o bandit-report.json || true
+
+      - name: Safety check
+        run: |
+          safety check --json --output safety-report.json || true
+        continue-on-error: true

.gitignore

@@ -1,10 +1,10 @@
 # Custom
-response.json
+your_data/
+pdm.lock
 
 # Virtual environments
 .venv/
 .pdm-python
-__pypackages__/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -44,6 +44,9 @@ MANIFEST
 # PyCharm idea folder
 .idea/
 
+# VS Code
+.vscode/
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
@@ -141,4 +144,4 @@ dmypy.json
 .pyre/
 
 # Ignore folder for local testing
-ignore/
+ignore/

.pre-commit-config.yaml

@@ -18,11 +18,24 @@ repos:
       - tomli
     exclude: 'cassettes/'
 
+- repo: https://github.com/psf/black
+  rev: 24.8.0
+  hooks:
+  - id: black
+    language_version: python3
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.4
+  hooks:
+  - id: ruff
+    args: [--fix, --unsafe-fixes]
+  - id: ruff-format
+
 - repo: local
   hooks:
-  - id: lint
-    name: lint
-    entry: make lint
+  - id: mypy
+    name: mypy type checking
+    entry: .venv/bin/pdm run mypy garminconnect tests
     types: [python]
     language: system
     pass_filenames: false

.vscode/settings.json

@@ -4,4 +4,4 @@
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true
-}
+}

LICENSE

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