Skip to main content

A robust, type-safe Python SDK for Garmin Connect data extraction.

Project description

Garmin Training Toolkit SDK

A robust, type-safe Python SDK for extracting biometric data and telemetry from Garmin Connect.

Purpose

This toolkit is designed as a raw data connector. It handles authentication, rate limiting, and data extraction from Garmin's unofficial APIs, returning clean, typed Pydantic models. It is built to be consumed by external Data Pipelines (like a Data Lakehouse) or AI systems (like LangGraph).

Note: This repository is strictly an SDK. It does not contain AI logic, training plan generators, or an API server (FastAPI).

Installation

This project uses uv for dependency management.

# In your consumer project (if using uv):
uv add git+https://github.com/restrok/garmin-training-toolkit-sdk.git#subdirectory=garmin_training_toolkit_sdk

Or for local development within this repository:

cd garmin_training_toolkit_sdk
uv sync

Quick Start

1. Authentication

Garmin uses session tokens. To log in and cache your session locally:

# Runs a headless browser to authenticate and save tokens
python3 garmin.py auth

2. Extracting Data (Python Example)

import json
from garmin_training_toolkit_sdk.utils import get_authenticated_client, find_token_file
from garmin_training_toolkit_sdk.extractors import get_activities, get_activity_telemetry

# 1. Connect
token_file = find_token_file()
client = get_authenticated_client(token_file)

# 2. Extract Activity Summary (Pydantic model)
activities = get_activities(client, "2026-04-10", "2026-04-20")
latest = activities[0]
print(f"Latest run: {latest.name} ({latest.distance_m} meters)")

# 3. Extract Detailed Telemetry (Second-by-second data)
telemetry = get_activity_telemetry(client, latest.id)
print(f"Total ticks: {telemetry.metric_count}")

# Pydantic makes serialization easy
print(json.dumps(telemetry.ticks[0].model_dump(), indent=2))

Available Extractors

All extractors return typed Pydantic models ensuring data reliability.

  • get_activities(client, start_date, end_date)
  • get_activity_telemetry(client, activity_id) -> Second-by-second telemetry (GPS, HR, Power, etc).
  • get_hrv_data(client, start_date, end_date)
  • get_sleep_data(client, start_date, end_date)
  • get_readiness_data(client, date)
  • get_body_battery(client, date)
  • get_stress_data(client, date)
  • get_training_status(client, date)

Workout Management & Uploaders

The SDK provides robust logic for managing your Garmin calendar and uploading custom workout plans.

1. Uploading Workouts

Supports "Triple Redundancy" targets (Pace/HR/Power) required by modern Garmin watches to display intensity targets correctly.

from garmin_training_toolkit_sdk.uploaders.workouts import create_workout

# 1. Create a workout dictionary (Triple Redundancy for Pace/HR targets)
workout_data = {
    "name": "Tempo Run",
    "duration": 2400,
    "steps": [
        {"type": "warmup", "duration": 600},
        {"type": "run", "duration": 1200, "target": "4:30 min/km"}
    ]
}
workout_dict = create_workout(workout_data)

# 2. Upload
client.upload_workout(workout_dict)

2. Calendar Management

Safely manage your schedule without affecting Garmin's "Auto Training Plans" (ATP).

from garmin_training_toolkit_sdk.uploaders.calendar import clear_calendar_range, schedule_workout

# Clear a specific range (Safely skips Garmin native plans)
clear_calendar_range(client, "2026-05-01", "2026-05-31")

# Schedule a workout
schedule_workout(client, workout_id="12345", workout_date="2026-05-15")

Testing & Mocks

The SDK includes a MockGarminClient to allow consumers to test their pipelines without hitting Garmin's rate limits or production APIs.

from garmin_training_toolkit_sdk.testing.mock import MockGarminClient

mock_client = MockGarminClient()
# Use mock_client exactly like a Garmin() instance

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

garmin_training_toolkit_sdk-0.2.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

garmin_training_toolkit_sdk-0.2.0-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file garmin_training_toolkit_sdk-0.2.0.tar.gz.

File metadata

  • Download URL: garmin_training_toolkit_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for garmin_training_toolkit_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 47246d7b42da6de4aa5c00a85608d4b924ec7de36851d8565a9a331881b99257
MD5 10940b3633caf710e137612079d3c06b
BLAKE2b-256 847ee3de912277c81e5319f11b859fcfedbbd6ec949bd7195f7e9c34424186b6

See more details on using hashes here.

File details

Details for the file garmin_training_toolkit_sdk-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: garmin_training_toolkit_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for garmin_training_toolkit_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5eb128e67a5d9be537f473a784708c82d32439af4c270db20a91f1706d5ef97a
MD5 e51b34a8f6738cd4bf91e3041de6d522
BLAKE2b-256 250946a4800b8484bb399b51b8c510e270c322844c2304725ec0146712f1f1fa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page