activity-parser 0.9.0__tar.gz → 0.10.0__tar.gz

activity_parser-0.10.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: activity-parser
+Version: 0.10.0
+Summary: Parser for loading FIT, TCX and GPX files into Pandas DataFrames.
+Project-URL: Repository, https://github.com/tabishm52/activity_parser
+Project-URL: Issues, https://github.com/tabishm52/activity_parser/issues
+Author-email: Tabish Mustufa <tabishm@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: fit,fitness,gps,gpx,pandas,parser,tcx
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.11
+Requires-Dist: fitdecode
+Requires-Dist: lxml
+Requires-Dist: pandas
+Description-Content-Type: text/markdown
+
+# activity-parser
+
+[![CI](https://github.com/tabishm52/activity_parser/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tabishm52/activity_parser/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/activity-parser)](https://pypi.org/project/activity-parser/)
+[![Python versions](https://img.shields.io/pypi/pyversions/activity-parser)](https://pypi.org/project/activity-parser/)
+[![License](https://img.shields.io/pypi/l/activity-parser)](https://pypi.org/project/activity-parser/)
+
+Parser for loading FIT, TCX and GPX activity files into Pandas DataFrames.
+
+Provides a parser object for reading (optionally gzipped) FIT, TCX, and GPX activity files and converting them into Pandas DataFrames.
+During import, field names extracted from activity files are normalized into a canonical set of output column names with consistent units to allow for standardized downstream data processing.
+
+## Installation
+
+```bash
+pip install activity-parser
+```
+
+## Usage
+
+Create a new instance of the `ActivityParser` class to be reused for subsequent parsing of activity files:
+
+```python
+import activity_parser
+parser = activity_parser.ActivityParser()
+```
+
+Parse FIT, TCX and GPX files into normalized DataFrames:
+
+```python
+records, laps, activity = parser.parse('path/to/fit_file.fit')
+records, laps, activity = parser.parse('path/to/gpx_file.gpx')
+records, laps, activity = parser.parse('path/to/tcx_file.tcx')
+```
+
+Each file is assumed to contain a single activity.
+Multiple activities/tracks (chained FIT files, multi-activity TCX, multi-track GPX) have their records/laps merged into one set of results.
+In those cases, the returned `Activity` summary reflects only the first activity/session in the file.
+
+## Output data
+
+`records` and `laps` are each a DataFrame of normalized data, e.g.:
+
+```
+                           distance  speed  cadence  heart_rate
+time
+2026-01-05 08:00:00+00:00      0.00   36.0       80         100
+2026-01-05 08:00:01+00:00      0.01   36.0       81         101
+```
+
+A few notes on column handling:
+
+- Column names and units are standardized across source formats for known field types.
+- Unknown fields are omitted by default; customize columns via `record_columns`, `lap_columns`, and `include_all_columns` on `ActivityParser` — see its docstring for details.
+- Not every column appears in every file: `parse()` only includes columns actually present.
+
+### Records
+
+Not all fields are available in all source formats.
+Fields marked with (\*) are exporter-dependent.
+
+| Column | Unit | FIT | TCX | GPX |
+|---|---|:-:|:-:|:-:|
+| `latitude`, `longitude` | degrees | Yes | Yes | Yes |
+| `altitude` | meters | Yes | Yes | Yes |
+| `distance` | km | Yes | Yes | (\*) |
+| `speed` | km/h | Yes | (\*) | (\*) |
+| `cadence` | rpm | Yes | Yes | (\*) |
+| `heart_rate` | bpm | Yes | Yes | (\*) |
+| `power` | watts | Yes | (\*) | (\*) |
+| `left_balance`, `right_balance` | percent | Yes | — | — |
+| `accumulated_power` | watts | Yes | — | — |
+| `temperature` | °C | Yes | — | (\*) |
+| `water_temperature` | °C | — | — | (\*) |
+| `depth` | meters | — | — | (\*) |
+| `course`, `bearing` | degrees | — | — | (\*) |
+
+### Laps
+
+GPX files have no lap data, so `laps` is always an empty DataFrame for GPX.
+Fields marked with (\*) are exporter-dependent.
+
+| Column | Unit | FIT | TCX |
+|---|---|:-:|:-:|
+| `start_time` | timestamp | Yes | Yes |
+| `total_elapsed_time` | seconds | Yes | Yes |
+| `total_timer_time` | seconds | Yes | — |
+| `start_position_lat`, `start_position_long` | degrees | Yes | — |
+| `end_position_lat`, `end_position_long` | degrees | Yes | — |
+| `total_distance` | km | Yes | Yes |
+| `total_ascent`, `total_descent` | meters | Yes | — |
+| `avg_vam` | m/s | Yes | — |
+| `avg_speed` | km/h | Yes | (\*) |
+| `max_speed` | km/h | Yes | Yes |
+| `avg_cadence` | rpm | Yes | Yes |
+| `max_cadence` | rpm | Yes | (\*) |
+| `total_strokes` | count | Yes | — |
+| `steps` | count | — | (\*) |
+| `avg_heart_rate`, `max_heart_rate` | bpm | Yes | Yes |
+| `time_in_hr_zone` | seconds | Yes | — |
+| `avg_power`, `max_power` | watts | Yes | (\*) |
+| `normalized_power` | watts | Yes | — |
+| `left_balance`, `right_balance` | percent | Yes | — |
+| `time_in_power_zone` | seconds | Yes | — |
+| `total_work` | joules | Yes | — |
+| `avg_temperature`, `max_temperature` | °C | Yes | — |
+| `total_calories` | kcal | Yes | Yes |
+| `total_fat_calories` | kcal | Yes | — |
+
+### Activity
+
+`activity` is an `Activity` dataclass instance: a small file-level summary.
+Fields are `None` when the source format/file doesn't record them.
+Values are transcribed from the file, never computed/derived from records or laps.
+
+| Field | Unit | FIT | TCX | GPX |
+|---|---|:-:|:-:|:-:|
+| `sport` | — | Yes | Yes | — |
+| `start_time` | — | Yes | Yes | Yes (\*) |
+| `total_elapsed_time` | seconds | Yes | — | — |
+| `total_distance` | km | Yes | — | — |
+| `total_calories` | kcal | Yes | — | — |
+| `avg_heart_rate`, `max_heart_rate` | bpm | Yes | — | — |
+| `avg_speed`, `max_speed` | kph | Yes | — | — |
+| `creator` | — | Yes | Yes | Yes |
+| `notes` | — | — | Yes | Yes |
+
+(\*) GPX's `start_time` comes from `metadata/time`, which is technically the file's export time rather than the activity's start.
+
+## Parser notes
+
+### FIT files
+
+FIT parsing wraps [`fitdecode`](https://github.com/polyvertex/fitdecode), which decodes against Garmin's public FIT SDK profile.
+Field values and types come from that profile, and units are converted via fitdecode's `StandardUnitsDataProcessor`.
+
+This package transforms certain FIT fields beyond the processing done by fitdecode:
+
+- Some fields have lower- and higher-precision versions; by default, `parse()` returns only the higher-precision value, under the base field's name.
+- Other fields store sub-integer precision in a separate field, which `parse()` adds into the base field.
+- FIT's pedal power balance is a single bit-packed byte (a side flag plus a percentage); `parse()` decodes it into `left_balance`/`right_balance`.
+
+Messages/fields fitdecode can't resolve against the profile (e.g. proprietary extensions) are kept as raw values under `unknown_<n>` names.
+
+### TCX & GPX files
+
+TCX and GPX files are parsed natively in this package.
+The parser supports the following schema versions and extensions:
+
+| Format | Schema version | Extensions |
+|---|---|---|
+| TCX | v2 | Garmin `ActivityExtension` v2 |
+| GPX | 1.0 / 1.1 | Garmin `TrackPointExtension` v1/v2, Cluetrust `gpxdata` |
+
+Unrecognized elements and attributes are exported as string columns named with their XML namespace in Clark notation.

activity_parser-0.10.0/README.md

@@ -0,0 +1,155 @@
+# activity-parser
+
+[![CI](https://github.com/tabishm52/activity_parser/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tabishm52/activity_parser/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/activity-parser)](https://pypi.org/project/activity-parser/)
+[![Python versions](https://img.shields.io/pypi/pyversions/activity-parser)](https://pypi.org/project/activity-parser/)
+[![License](https://img.shields.io/pypi/l/activity-parser)](https://pypi.org/project/activity-parser/)
+
+Parser for loading FIT, TCX and GPX activity files into Pandas DataFrames.
+
+Provides a parser object for reading (optionally gzipped) FIT, TCX, and GPX activity files and converting them into Pandas DataFrames.
+During import, field names extracted from activity files are normalized into a canonical set of output column names with consistent units to allow for standardized downstream data processing.
+
+## Installation
+
+```bash
+pip install activity-parser
+```
+
+## Usage
+
+Create a new instance of the `ActivityParser` class to be reused for subsequent parsing of activity files:
+
+```python
+import activity_parser
+parser = activity_parser.ActivityParser()
+```
+
+Parse FIT, TCX and GPX files into normalized DataFrames:
+
+```python
+records, laps, activity = parser.parse('path/to/fit_file.fit')
+records, laps, activity = parser.parse('path/to/gpx_file.gpx')
+records, laps, activity = parser.parse('path/to/tcx_file.tcx')
+```
+
+Each file is assumed to contain a single activity.
+Multiple activities/tracks (chained FIT files, multi-activity TCX, multi-track GPX) have their records/laps merged into one set of results.
+In those cases, the returned `Activity` summary reflects only the first activity/session in the file.
+
+## Output data
+
+`records` and `laps` are each a DataFrame of normalized data, e.g.:
+
+```
+                           distance  speed  cadence  heart_rate
+time
+2026-01-05 08:00:00+00:00      0.00   36.0       80         100
+2026-01-05 08:00:01+00:00      0.01   36.0       81         101
+```
+
+A few notes on column handling:
+
+- Column names and units are standardized across source formats for known field types.
+- Unknown fields are omitted by default; customize columns via `record_columns`, `lap_columns`, and `include_all_columns` on `ActivityParser` — see its docstring for details.
+- Not every column appears in every file: `parse()` only includes columns actually present.
+
+### Records
+
+Not all fields are available in all source formats.
+Fields marked with (\*) are exporter-dependent.
+
+| Column | Unit | FIT | TCX | GPX |
+|---|---|:-:|:-:|:-:|
+| `latitude`, `longitude` | degrees | Yes | Yes | Yes |
+| `altitude` | meters | Yes | Yes | Yes |
+| `distance` | km | Yes | Yes | (\*) |
+| `speed` | km/h | Yes | (\*) | (\*) |
+| `cadence` | rpm | Yes | Yes | (\*) |
+| `heart_rate` | bpm | Yes | Yes | (\*) |
+| `power` | watts | Yes | (\*) | (\*) |
+| `left_balance`, `right_balance` | percent | Yes | — | — |
+| `accumulated_power` | watts | Yes | — | — |
+| `temperature` | °C | Yes | — | (\*) |
+| `water_temperature` | °C | — | — | (\*) |
+| `depth` | meters | — | — | (\*) |
+| `course`, `bearing` | degrees | — | — | (\*) |
+
+### Laps
+
+GPX files have no lap data, so `laps` is always an empty DataFrame for GPX.
+Fields marked with (\*) are exporter-dependent.
+
+| Column | Unit | FIT | TCX |
+|---|---|:-:|:-:|
+| `start_time` | timestamp | Yes | Yes |
+| `total_elapsed_time` | seconds | Yes | Yes |
+| `total_timer_time` | seconds | Yes | — |
+| `start_position_lat`, `start_position_long` | degrees | Yes | — |
+| `end_position_lat`, `end_position_long` | degrees | Yes | — |
+| `total_distance` | km | Yes | Yes |
+| `total_ascent`, `total_descent` | meters | Yes | — |
+| `avg_vam` | m/s | Yes | — |
+| `avg_speed` | km/h | Yes | (\*) |
+| `max_speed` | km/h | Yes | Yes |
+| `avg_cadence` | rpm | Yes | Yes |
+| `max_cadence` | rpm | Yes | (\*) |
+| `total_strokes` | count | Yes | — |
+| `steps` | count | — | (\*) |
+| `avg_heart_rate`, `max_heart_rate` | bpm | Yes | Yes |
+| `time_in_hr_zone` | seconds | Yes | — |
+| `avg_power`, `max_power` | watts | Yes | (\*) |
+| `normalized_power` | watts | Yes | — |
+| `left_balance`, `right_balance` | percent | Yes | — |
+| `time_in_power_zone` | seconds | Yes | — |
+| `total_work` | joules | Yes | — |
+| `avg_temperature`, `max_temperature` | °C | Yes | — |
+| `total_calories` | kcal | Yes | Yes |
+| `total_fat_calories` | kcal | Yes | — |
+
+### Activity
+
+`activity` is an `Activity` dataclass instance: a small file-level summary.
+Fields are `None` when the source format/file doesn't record them.
+Values are transcribed from the file, never computed/derived from records or laps.
+
+| Field | Unit | FIT | TCX | GPX |
+|---|---|:-:|:-:|:-:|
+| `sport` | — | Yes | Yes | — |
+| `start_time` | — | Yes | Yes | Yes (\*) |
+| `total_elapsed_time` | seconds | Yes | — | — |
+| `total_distance` | km | Yes | — | — |
+| `total_calories` | kcal | Yes | — | — |
+| `avg_heart_rate`, `max_heart_rate` | bpm | Yes | — | — |
+| `avg_speed`, `max_speed` | kph | Yes | — | — |
+| `creator` | — | Yes | Yes | Yes |
+| `notes` | — | — | Yes | Yes |
+
+(\*) GPX's `start_time` comes from `metadata/time`, which is technically the file's export time rather than the activity's start.
+
+## Parser notes
+
+### FIT files
+
+FIT parsing wraps [`fitdecode`](https://github.com/polyvertex/fitdecode), which decodes against Garmin's public FIT SDK profile.
+Field values and types come from that profile, and units are converted via fitdecode's `StandardUnitsDataProcessor`.
+
+This package transforms certain FIT fields beyond the processing done by fitdecode:
+
+- Some fields have lower- and higher-precision versions; by default, `parse()` returns only the higher-precision value, under the base field's name.
+- Other fields store sub-integer precision in a separate field, which `parse()` adds into the base field.
+- FIT's pedal power balance is a single bit-packed byte (a side flag plus a percentage); `parse()` decodes it into `left_balance`/`right_balance`.
+
+Messages/fields fitdecode can't resolve against the profile (e.g. proprietary extensions) are kept as raw values under `unknown_<n>` names.
+
+### TCX & GPX files
+
+TCX and GPX files are parsed natively in this package.
+The parser supports the following schema versions and extensions:
+
+| Format | Schema version | Extensions |
+|---|---|---|
+| TCX | v2 | Garmin `ActivityExtension` v2 |
+| GPX | 1.0 / 1.1 | Garmin `TrackPointExtension` v1/v2, Cluetrust `gpxdata` |
+
+Unrecognized elements and attributes are exported as string columns named with their XML namespace in Clark notation.

{activity_parser-0.9.0 → activity_parser-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "activity-parser"
-version = "0.9.0"
+version = "0.10.0"
 description = "Parser for loading FIT, TCX and GPX files into Pandas DataFrames."
 readme = "README.md"
 license = "MIT"
@@ -35,6 +35,7 @@ Issues = "https://github.com/tabishm52/activity_parser/issues"
 
 [dependency-groups]
 dev = [
+    "garmin-fit-sdk",
     "lxml-stubs",
     "pandas-stubs",
     "pre-commit",

{activity_parser-0.9.0 → activity_parser-0.10.0}/src/activity_parser/__init__.py

@@ -1,10 +1,12 @@
 """Parser for loading FIT, TCX and GPX files into Pandas DataFrames."""
 
+from .output import Activity
 from .parse_activity import ActivityParser
 from .parse_fit_file import parse_fit
 from .parse_tcx_gpx import parse_gpx, parse_tcx
 
 __all__ = [
+    "Activity",
     "ActivityParser",
     "parse_fit",
     "parse_gpx",

activity_parser-0.10.0/src/activity_parser/output.py

@@ -0,0 +1,79 @@
+"""Defines the shape of ``parse()``'s return values, shared across FIT/TCX/GPX."""
+
+from dataclasses import dataclass
+
+import pandas as pd
+
+DEFAULT_RECORD_COLUMNS: tuple[str, ...] = (
+    "latitude",
+    "longitude",
+    "altitude",
+    "distance",
+    "speed",
+    "cadence",
+    "heart_rate",
+    "power",
+    "left_balance",
+    "right_balance",
+    "accumulated_power",
+    "temperature",
+    "water_temperature",
+    "depth",
+    "course",
+    "bearing",
+)
+
+DEFAULT_LAP_COLUMNS: tuple[str, ...] = (
+    "start_time",
+    "total_elapsed_time",
+    "total_timer_time",
+    "start_position_lat",
+    "start_position_long",
+    "end_position_lat",
+    "end_position_long",
+    "total_distance",
+    "total_ascent",
+    "total_descent",
+    "avg_vam",
+    "avg_speed",
+    "max_speed",
+    "avg_cadence",
+    "max_cadence",
+    "total_strokes",
+    "steps",
+    "avg_heart_rate",
+    "max_heart_rate",
+    "time_in_hr_zone",
+    "avg_power",
+    "max_power",
+    "normalized_power",
+    "left_balance",
+    "right_balance",
+    "time_in_power_zone",
+    "total_work",
+    "avg_temperature",
+    "max_temperature",
+    "total_calories",
+    "total_fat_calories",
+)
+
+
+@dataclass(frozen=True)
+class Activity:
+    """File-level summary, present across FIT/TCX/GPX.
+
+    Fields are ``None`` when the source format/file doesn't record them. Values are
+    transcribed from the file, never computed/derived from records or laps.
+    """
+
+    sport: str | None = None
+    start_time: pd.Timestamp | None = None
+    total_elapsed_time: float | None = None  # seconds
+    total_distance: float | None = None  # km
+    total_calories: float | None = None
+    avg_heart_rate: float | None = None
+    max_heart_rate: float | None = None
+    avg_speed: float | None = None  # kph
+    max_speed: float | None = None  # kph
+    creator: str | None = None  # device/app that recorded or wrote the file
+    notes: str | None = None

activity_parser-0.10.0/src/activity_parser/parse_activity.py

@@ -0,0 +1,137 @@
+"""Class for parsing FIT, TCX and GPX files into Pandas DataFrames."""
+
+from collections.abc import Sequence
+from os import PathLike
+from pathlib import Path
+from typing import IO
+
+import pandas as pd
+
+from .output import DEFAULT_LAP_COLUMNS, DEFAULT_RECORD_COLUMNS, Activity
+from .parse_fit_file import parse_fit
+from .parse_tcx_gpx import parse_gpx, parse_tcx
+
+
+def select_and_reorder_cols(
+    df: pd.DataFrame,
+    columns: Sequence[str],
+    include_all_columns: bool,
+) -> pd.DataFrame:
+    """Selects and reorders df's columns.
+
+    Columns from ``columns`` present in ``df`` are selected, in that order; columns
+    absent from ``df`` are omitted.
+
+    If ``include_all_columns`` is True, any of ``df``'s remaining columns not in
+    ``columns`` are appended afterward, in their original order.
+    """
+    present = [col for col in columns if col in df.columns]
+    if include_all_columns:
+        selected = set(columns)
+        extra = [col for col in df.columns if col not in selected]
+        ordered = present + extra
+    else:
+        ordered = present
+    return df.loc[:, ordered]
+
+
+def normalize_extension(ext: str) -> str:
+    """Normalize an extension string to one of: fit, tcx, gpx."""
+    normalized = ext.lower().lstrip(".")
+    if normalized == "gz":
+        raise ValueError("Ambiguous extension: .gz without base extension.")
+    return normalized
+
+
+def infer_extension(file: str | PathLike[str]) -> str:
+    """Infer normalized extension from a path-like input."""
+    p = Path(file)
+    ext = p.suffix
+    if ext.lower() == ".gz":
+        ext = Path(p.stem).suffix
+    return normalize_extension(ext)
+
+
+class ActivityParser:
+    """Parser for FIT, GPX and TCX files.
+
+    Each instance of this class is a parser object that can be used to import FIT, GPX
+    and TCX files into DataFrames. During parsing, the column names in the resulting
+    DataFrames are normalized to a standard set of names to allow for more
+    interchangeable use of DataFrames from the different activity file types.
+
+    The output of ``parse`` is controlled by ``record_columns`` and ``lap_columns``,
+    which are set on each instance from ``default_columns``. Reassign or mutate them to
+    select different columns.
+    """
+
+    def __init__(
+        self,
+        *,
+        include_all_columns: bool = False,
+        check_crc: bool = False,
+        strict_xml: bool = False,
+    ) -> None:
+        """Initialize parser settings and column lists.
+
+        Args:
+            include_all_columns: If True, ``parse`` returns all parsed columns. If
+                False, ``parse`` returns only the columns in ``record_columns`` and
+                ``lap_columns``.
+            check_crc: If True, ``parse`` raises ``fitdecode.FitCRCError`` on a CRC
+                mismatch in FIT files. If False, CRC verification is skipped.
+            strict_xml: If True, ``parse`` raises ``lxml.etree.XMLSyntaxError`` on
+                malformed TCX/GPX XML. If False, parser recovery is enabled.
+        """
+        self.record_columns: list[str] = list(DEFAULT_RECORD_COLUMNS)
+        self.lap_columns: list[str] = list(DEFAULT_LAP_COLUMNS)
+        self.include_all_columns = include_all_columns
+        self.check_crc = check_crc
+        self.strict_xml = strict_xml
+
+    def parse(
+        self,
+        file: str | PathLike[str] | IO[bytes],
+        ext: str | None = None,
+    ) -> tuple[pd.DataFrame, pd.DataFrame, Activity]:
+        """Loads a FIT, TCX or GPX activity into Pandas DataFrames.
+
+        Output columns come from ``record_columns``/``lap_columns``, plus any extra
+        columns if ``include_all_columns`` is set. Not all columns are guaranteed to
+        appear, only those present in the activity file.
+
+        Args:
+            file: Binary file-like or path-like object. A path-like argument ending in
+                ``.gz`` will be unzipped before processing.
+            ext: File type, case-insensitive: ``fit``, ``tcx``, or ``gpx``. Required for
+                a file-like ``file``; optional for a path-like ``file`` (inferred from
+                the name).
+
+        Returns:
+            Tuple containing records, laps, and an ``Activity`` summary.
+        """
+        if ext is not None:
+            ext_normalized = normalize_extension(ext)
+        elif isinstance(file, (str, PathLike)):
+            ext_normalized = infer_extension(file)
+        else:
+            raise ValueError("ext must be provided when file is a file-like object.")
+
+        if ext_normalized == "fit":
+            records, laps, activity = parse_fit(file, check_crc=self.check_crc)
+
+        elif ext_normalized == "tcx":
+            records, laps, activity = parse_tcx(file, strict_xml=self.strict_xml)
+
+        elif ext_normalized == "gpx":
+            # Note GPX files have no lap information; laps is always empty.
+            records, laps, activity = parse_gpx(file, strict_xml=self.strict_xml)
+
+        else:
+            raise ValueError(f"File type not supported: {ext_normalized}")
+
+        records = select_and_reorder_cols(records, self.record_columns, self.include_all_columns)
+        records.rename_axis("time", inplace=True)
+        laps = select_and_reorder_cols(laps, self.lap_columns, self.include_all_columns)
+
+        return records, laps, activity