sweatstack 0.37.0__tar.gz → 0.40.0__tar.gz

{sweatstack-0.37.0 → sweatstack-0.40.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sweatstack
-Version: 0.37.0
+Version: 0.40.0
 Summary: The official Python client for SweatStack
 Author-email: Aart Goossens <aart@gssns.io>
 Requires-Python: >=3.9

{sweatstack-0.37.0 → sweatstack-0.40.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sweatstack"
-version = "0.37.0"
+version = "0.40.0"
 description = "The official Python client for SweatStack"
 readme = "README.md"
 authors = [

{sweatstack-0.37.0 → sweatstack-0.40.0}/src/sweatstack/client.py

@@ -444,7 +444,7 @@ class Client(OAuth2Mixin, DelegationMixin):
         tags: list[str] | None = None,
         limit: int = 100,
         as_dataframe: bool = False,
-    ) -> Generator[ActivitySummary, None, None] | pd.DataFrame:
+    ) -> list[ActivitySummary] | pd.DataFrame:
         """Gets a list of activities based on specified filters.
 
         Args:
@@ -456,28 +456,27 @@ class Client(OAuth2Mixin, DelegationMixin):
             as_dataframe: Whether to return results as a pandas DataFrame. Defaults to False.
 
         Returns:
-            Either a generator yielding ActivitySummary objects or a pandas DataFrame containing
+            Either a list of ActivitySummary objects or a pandas DataFrame containing
             the activities data, depending on the value of as_dataframe.
 
         Raises:
             HTTPStatusError: If the API request fails.
         """
-        generator = self._get_activities_generator(
+        activities = list(self._get_activities_generator(
             start=start,
             end=end,
             sports=sports,
             tags=tags,
             limit=limit,
-        )
+        ))
         if as_dataframe:
-            df = pd.DataFrame([activity.model_dump() for activity in generator])
-            df = df.set_index(df["start"].rename("timestamp"))
+            df = pd.DataFrame([activity.model_dump() for activity in activities])
             df = self._normalize_dataframe_column(df, "summary")
             df = self._normalize_dataframe_column(df, "laps")
             df = self._normalize_dataframe_column(df, "traces")
             return self._postprocess_dataframe(df)
         else:
-            return generator
+            return activities
 
     def get_latest_activity(
         self,
@@ -502,7 +501,7 @@ class Client(OAuth2Mixin, DelegationMixin):
             StopIteration: If no activities match the filters.
             HTTPStatusError: If the API request fails.
         """
-        return next(self.get_activities(
+        return next(self._get_activities_generator(
             start=start,
             end=end,
             sports=[sport] if sport is not None else None,
@@ -841,7 +840,7 @@ class Client(OAuth2Mixin, DelegationMixin):
         tags: list[str] | None = None,
         limit: int = 100,
         as_dataframe: bool = False,
-    ) -> Generator[TraceDetails, None, None] | pd.DataFrame:
+    ) -> list[TraceDetails] | pd.DataFrame:
         """Gets a list of traces based on specified filters.
 
         Args:
@@ -853,23 +852,23 @@ class Client(OAuth2Mixin, DelegationMixin):
             as_dataframe: Whether to return results as a pandas DataFrame. Defaults to False.
 
         Returns:
-            Either a generator yielding TraceDetails objects or a pandas DataFrame containing
+            Either a list of TraceDetails objects or a pandas DataFrame containing
             the traces data, depending on the value of as_dataframe.
 
         Raises:
             HTTPStatusError: If the API request fails.
         """
-        generator = self._get_traces_generator(
+        traces = list(self._get_traces_generator(
             start=start,
             end=end,
             sports=sports,
             tags=tags,
             limit=limit,
-        )
+        ))
         if not as_dataframe:
-            return generator
+            return traces
 
-        data = pd.DataFrame([trace.model_dump() for trace in generator])
+        data = pd.DataFrame([trace.model_dump() for trace in traces])
 
         if "activity" in data.columns:
             data = self._normalize_dataframe_column(data, "activity")

{sweatstack-0.37.0 → sweatstack-0.40.0}/src/sweatstack/openapi_schemas.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2025-04-08T11:14:52+00:00
+#   timestamp: 2025-04-11T08:42:56+00:00
 
 from __future__ import annotations
 
@@ -332,6 +332,8 @@ class Lap(BaseModel):
     start: datetime = Field(..., title='Start')
     end: datetime = Field(..., title='End')
     duration: timedelta = Field(..., title='Duration')
+    start_local: datetime = Field(..., title='Start Local')
+    end_local: datetime = Field(..., title='End Local')
 
 
 class ActivityDetails(BaseModel):
@@ -347,6 +349,8 @@ class ActivityDetails(BaseModel):
     traces: Optional[List[TraceDetails]] = Field(None, title='Traces')
     distance: Optional[float] = Field(None, title='Distance')
     duration: timedelta = Field(..., title='Duration')
+    start_local: datetime = Field(..., title='Start Local')
+    end_local: datetime = Field(..., title='End Local')
 
 
 class ActivitySummary(BaseModel):
@@ -361,6 +365,8 @@ class ActivitySummary(BaseModel):
     laps: Optional[List[Lap]] = Field(None, title='Laps')
     traces: Optional[List[TraceDetails]] = Field(None, title='Traces')
     duration: timedelta = Field(..., title='Duration')
+    start_local: datetime = Field(..., title='Start Local')
+    end_local: datetime = Field(..., title='End Local')
 
 
 class TraceDetails(BaseModel):
@@ -376,6 +382,7 @@ class TraceDetails(BaseModel):
     lap: Optional[Lap] = None
     activity: Optional[ActivitySummary] = None
     sport: Optional[Sport] = None
+    timestamp_local: datetime = Field(..., title='Timestamp Local')
 
 
 ActivityDetails.model_rebuild()

sweatstack-0.40.0/src/sweatstack/schemas.py

@@ -0,0 +1,104 @@
+from enum import Enum
+from typing import List, Union
+
+from .openapi_schemas import (
+    ActivityDetails, ActivitySummary, Metric, Scope, Sport,
+    TraceDetails, UserInfoResponse, UserSummary
+)
+
+
+def parent_sport(sport: Sport) -> Sport:
+    """Returns the parent sport of a given sport.
+
+    For sports with a hierarchical structure (e.g., 'cycling.road'), returns the parent sport
+    ('cycling'). If the sport has no parent (is already a root sport), returns the sport itself.
+
+    Args:
+        sport (Sport): The sport enum value to find the parent of.
+
+    Returns:
+        Sport: The parent sport enum value, or the original sport if it has no parent.
+    """
+    parts = sport.value.split(".")
+    if len(parts) == 1:
+        return sport
+    return sport.__class__(".".join(parts[:-1]))
+
+
+def root_sport(sport: Sport) -> Sport:
+    """Returns the root sport of a given sport.
+
+    For sports with a hierarchical structure (e.g., 'cycling.road' or 'cycling.road.gravel'),
+    returns the root sport ('cycling'). If the sport is already a root sport, returns the sport itself.
+
+    Args:
+        sport (Sport): The sport enum value to find the root of.
+
+    Returns:
+        Sport: The root sport enum value.
+    """
+    return sport.__class__(sport.value.split(".")[0])
+
+
+def is_root_sport(sport: Sport) -> bool:
+    """Determines if a sport is a root sport.
+
+    A root sport is one that doesn't have a parent sport in the hierarchy
+    (e.g., 'cycling' is a root sport, while 'cycling.road' is not).
+
+    Args:
+        sport (Sport): The sport enum value to check.
+
+    Returns:
+        bool: True if the sport is a root sport, False otherwise.
+    """
+    return sport == root_sport(sport)
+
+
+def is_sub_sport_of(sport: Sport, sport_or_sports: Union[Sport, List[Sport]]) -> bool:
+    """Determines if a sport is a sub-sport of another sport or list of sports.
+
+    For example, 'cycling.road' is a sub-sport of 'cycling', but not of 'running'.
+
+    Args:
+        sport (Sport): The sport to check.
+        sport_or_sports (Union[Sport, List[Sport]]): A sport or list of sports to check against.
+
+    Returns:
+        bool: True if the sport is a sub-sport of any of the provided sports, False otherwise.
+
+    Raises:
+        ValueError: If sport_or_sports is not a Sport or a list of Sports.
+    """
+    if isinstance(sport_or_sports, Sport):
+        return sport.value.startswith(sport_or_sports.value)
+    elif isinstance(sport_or_sports, (list, tuple)):
+        return any(is_sub_sport_of(sport, sport) for sport in sport_or_sports)
+    else:
+        raise ValueError(f"Invalid type for sport_or_sports: {type(sport_or_sports)}")
+
+
+def display_name(sport: Sport) -> str:
+    """Returns a human-readable display name for a sport.
+
+    This function converts a Sport enum value into a formatted string suitable for display.
+
+    Args:
+        sport (Sport): The sport enum value to format.
+
+    Returns:
+        str: A human-readable display name for the sport.
+    """
+    parts = sport.value.split(".")
+    base_sport = parts[0]
+    base_sport = base_sport.replace("_", " ")
+    if len(parts) == 1:
+        return base_sport
+    the_rest = " ".join(parts[1:]).replace("_", " ")
+    return f"{base_sport} ({the_rest})"
+
+
+Sport.root_sport = root_sport
+Sport.parent_sport = parent_sport
+Sport.is_sub_sport_of = is_sub_sport_of
+Sport.display_name = display_name

{sweatstack-0.37.0 → sweatstack-0.40.0}/src/sweatstack/utils.py

@@ -52,29 +52,4 @@ def make_dataframe_streamlit_compatible(df: pd.DataFrame) -> pd.DataFrame:
                         lambda x: x.value if isinstance(x, Enum) else x
                     )
 
-    return df_copy if df_copy is not None else df
-
-
-def format_sport(sport: Sport):
-    """Formats a sport enum value into a human-readable string.
-
-    This function takes a Sport enum and converts it to a formatted string representation.
-    For example, "cycling.road" becomes "cycling (road)" and "running" remains "running".
-    Underscores in sport names are replaced with spaces.
-
-    Args:
-        sport: A Sport enum value to format.
-
-    Returns:
-        str: A human-readable formatted string representation of the sport.
-    """
-    parts = sport.value.split(".")
-    base_sport = parts[0]
-    base_sport = base_sport.replace("_", " ")
-
-    if len(parts) == 1:
-        return base_sport
-
-    remainder = " ".join(parts[1:]).replace("_", " ")
-
-    return f"{base_sport} ({remainder})"
+    return df_copy if df_copy is not None else df

sweatstack-0.37.0/src/sweatstack/schemas.py

@@ -1,5 +0,0 @@
-from enum import Enum
-
-from .openapi_schemas import (
-    ActivityDetails, ActivitySummary, Metric, Scope, Sport, TraceDetails, UserInfoResponse, UserSummary
-)