add description to workouts

.coderabbit.yaml

@@ -0,0 +1,29 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json # Schema for CodeRabbit configurations
+language: "en-US"
+early_access: true
+reviews:
+  profile: "assertive"
+  request_changes_workflow: true
+  high_level_summary: true
+  poem: false
+  review_status: true
+  collapse_walkthrough: false
+  auto_review:
+    enabled: true
+    drafts: false
+
+  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/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: [cyberjunky] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "20:00"
+      timezone: "Europe/Amsterdam"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "20:00"
+      timezone: "Europe/Amsterdam"

.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+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@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        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 ruff
+        run: |
+          pdm run ruff format --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: Check for coverage report
+        id: coverage_check
+        run: |
+          if [ -f coverage.xml ]; then
+            echo "coverage_generated=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "coverage_generated=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Upload coverage artifact
+        if: matrix.python-version == '3.11' && steps.coverage_check.outputs.coverage_generated == 'true'
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-xml
+          path: coverage.xml
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        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,3 +1,12 @@
+# Custom
+your_data/
+pdm.lock
+garth/
+
+# Virtual environments
+.venv/
+.pdm-python
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -33,6 +42,12 @@ MANIFEST
 *.manifest
 *.spec
 
+# PyCharm idea folder
+.idea/
+
+# VS Code
+.vscode/
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
@@ -103,6 +118,7 @@ celerybeat.pid
 
 # Environments
 .env
+.envrc
 .venv
 env/
 venv/
@@ -127,3 +143,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Ignore folder for local testing
+ignore/

.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+exclude: '.*\.ipynb$'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-yaml
+    args: ['--unsafe']
+  - id: check-toml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.5
+  hooks:
+  - id: codespell
+    additional_dependencies:
+      - tomli
+    exclude: 'cassettes/'
+
+# Removed black - using ruff-format instead to avoid formatting conflicts
+# - 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.12.11
+  hooks:
+  - id: ruff
+    args: [--fix, --unsafe-fixes]
+  - id: ruff-format
+
+- repo: local
+  hooks:
+  - id: mypy
+    name: mypy type checking
+    entry: bash -c 'cd "$PWD" && .venv/bin/mypy garminconnect tests'
+    types: [python]
+    language: system
+    pass_filenames: false

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Ron Klinkien
+Copyright (c) 2020-2026 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