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)

Included Modules

While the core focus is extraction, the SDK also bundles:

  • garmin_training_toolkit_sdk.uploaders: Logic for uploading custom workout plans back to Garmin.
  • garmin_training_toolkit_sdk.weather: A local SQLite-backed weather module (OpenMeteo) to enrich activity data with historical weather context.

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.1.3.tar.gz (27.6 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.1.3-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garmin_training_toolkit_sdk-0.1.3.tar.gz
  • Upload date:
  • Size: 27.6 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.1.3.tar.gz
Algorithm Hash digest
SHA256 0f744da88f38f6ae084de7fdc3a44a69d6a94d6b95a92422c1ab89bcb1a8c227
MD5 93cf2bccb51c69c343a325aa87a560f7
BLAKE2b-256 b9278cb1fc4abff4699996216249b41c43312a3c84cb35fb00f2bf4924df1f10

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garmin_training_toolkit_sdk-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 35.3 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.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f1e0121b54fe416808aef40e3d73208591967290b3f321f84158788077e57c17
MD5 c7d93fcbf7582453c1fd0fc400726360
BLAKE2b-256 80d5944db14e02184bf980253404bd7345323087436bf174c593be9b55164ecf

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