fitparserx 0.1.5

Parse Garmin .fit wellness data, process it, and make DataFrame and NumPy arrays

fitparserx

A Python library for parsing Garmin .fit files and extracting wellness data (heart rate, stress level, respiration rate) into convenient Python structures (pandas DataFrame, NumPy array). These data are sourced from Garmin Wellness exports: either the daily export (Account Settings > Account Information > Export Wellness Data) or the full archive emailed via the Data Management page. Support for the Garmin activity data will be added in a future release.

Features

Uses Garmin .fit files decoded with the garmin_fit_sdk to:

• Extract proper datetimes and heart rate data.
• Optionally include respiration rate and stress level data.
• Converts the raw data into a pandas DataFrame or a NumPy array.
• Timezone‑aware datetime handling.
• Integrating estimated sleep data.

Installation

1. (Optional) Create and activate a virtual environment:

python3 -m venv .venv
source .venv/bin/activate

2. Install the package using pip:

pip install fitparserx

Usage

from fitparserx import FitParser

Initialize parser pointing to a directory or single file

Put your data into a data/ file. Otherwise, the parser goes through data in the current working directory. You can also point a path to a specific file.

mode='all' requires email prefix for .fit filenames

parser = FitParser(path="./data", email="[e-mail]", mode="all")

DataFrame

Convert to a pandas DataFrame with datetimes and metrics:

# Only heart rate (default)
fit_df = parser.to_dataframe()

# Include stress level and respiration rate, fill missing with NaN
fit_df = parser.to_dataframe(add_metrics=["stress_level", "respiration_rate"], timezone="UTC")

Include the type of activity at each moment (e.g. 'sedentary' or 'walking') using the "add_state" flag:

fit_df = parser.to_dataframe(add_state=True)

Choose a filling strategy for missing data via the fill parameter. By default (fill=None), raw values are retained. If you set fill='NaN', any non-positive entries in "heart_rate", "stress_level" and "respiration_rate" will be replaced with NaN.

fit_df = parser.to_dataframe(fill='NaN')

Sleep Data

After downloading your user data from Data Management, you’ll find your sleep data in JSON files located in the directory DI_CONNECT/DI-Connect-Wellness. To add a Boolean column indicating sleep state (True for sleeping, no_sleep otherwise, defaults to False), call the add_sleep() method on the parser:

parser = FitParser(...)
parser.add_sleep(path="./sleep_data") 

To get only the sleep time data, call the method parse_sleep_data():

sleeptimes = parser.parse_sleep_data(path="./sleep_data", timezone=timezone)

Note: parser.timezone is the timezone of the dataframe datetimes; setting option timezone in parse_sleep_data() doesn't change parser.timezone.

NumPy Array

fit_np = parser.to_numpy()

License

MIT License