Merge pull request #339 from miki134/workout-description

Added descriptions to workouts

Author: cyberjunky

garminconnect/workout.py

@@ -178,6 +178,7 @@ class BaseWorkout(BaseModel):
     estimatedDurationInSecs: int
     workoutSegments: list[WorkoutSegment]
     author: dict[str, Any] = Field(default_factory=dict)
+    description: str | None = None
 
     class Config:
         """Pydantic config."""

test_data/sample_cycling_workout.py

@@ -15,6 +15,7 @@ def create_sample_cycling_workout() -> CyclingWorkout:
     """Create a sample interval cycling workout."""
     return CyclingWorkout(
         workoutName="Cycling Power Intervals",
+        description="A sample cycling power interval workout with warmup, power intervals with recovery, and cooldown.",
         estimatedDurationInSecs=3600,  # 60 minutes
         workoutSegments=[
             WorkoutSegment(

test_data/sample_hiking_workout.py

@@ -12,6 +12,7 @@ def create_sample_hiking_workout() -> HikingWorkout:
     """Create a sample hiking workout."""
     return HikingWorkout(
         workoutName="Mountain Hiking Trail",
+        description="A sample hiking workout featuring a mountain trail with warmup and cooldown phases.",
         estimatedDurationInSecs=7200,  # 2 hours
         workoutSegments=[
             WorkoutSegment(

test_data/sample_running_workout.py

@@ -16,6 +16,7 @@ def create_sample_running_workout() -> RunningWorkout:
     return RunningWorkout(
         workoutName="Interval Running Session",
         estimatedDurationInSecs=1800,  # 30 minutes
+        description="A sample interval running workout with warmup, intervals, recovery, and cooldown.",
         workoutSegments=[
             WorkoutSegment(
                 segmentOrder=1,

test_data/sample_swimming_workout.py

@@ -15,6 +15,7 @@ def create_sample_swimming_workout() -> SwimmingWorkout:
     """Create a sample swimming workout."""
     return SwimmingWorkout(
         workoutName="Swimming Interval Training",
+        description="A sample swimming interval workout with warmup, multiple intervals with recovery, and cooldown.",
         estimatedDurationInSecs=2400,  # 40 minutes
         workoutSegments=[
             WorkoutSegment(

test_data/sample_walking_workout.py

@@ -12,6 +12,7 @@ def create_sample_walking_workout() -> WalkingWorkout:
     """Create a sample walking workout."""
     return WalkingWorkout(
         workoutName="Brisk Walking Session",
+        description="A sample brisk walking workout with continuous pace and warmup/cooldown phases.",
         estimatedDurationInSecs=2700,  # 45 minutes
         workoutSegments=[
             WorkoutSegment(