sweatstack 0.36.0__tar.gz → 0.38.0__tar.gz

{sweatstack-0.36.0 → sweatstack-0.38.0}/PKG-INFO

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

{sweatstack-0.36.0 → sweatstack-0.38.0}/pyproject.toml

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

sweatstack-0.38.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.36.0 → sweatstack-0.38.0}/src/sweatstack/streamlit.py

@@ -1,6 +1,7 @@
 import os
 import urllib.parse
 from datetime import date
+from typing import List, Union
 try:
     import streamlit as st
 except ImportError:
@@ -13,21 +14,37 @@ import httpx
 
 from .client import Client
 from .constants import DEFAULT_URL
-from .schemas import Metric, Sport
+from .schemas import Metric, Scope, Sport
 from .utils import format_sport
 
 class StreamlitAuth:
-    def __init__(self, client_id=None, client_secret=None, scope=None, redirect_uri=None):
+    def __init__(
+        self,
+        client_id=None,
+        client_secret=None,
+        scopes: List[Union[str, Scope]]=None,
+        redirect_uri=None,
+    ):
         """
         Args:
             client_id: The client ID to use. If not provided, the SWEATSTACK_CLIENT_ID environment variable will be used.
             client_secret: The client secret to use. If not provided, the SWEATSTACK_CLIENT_SECRET environment variable will be used.
-            scope: The scope to use. If not provided, the SWEATSTACK_SCOPE environment variable will be used.
+            scopes: The scopes to use. If not provided, the SWEATSTACK_SCOPES environment variable will be used. Defaults to data:read, profile.
             redirect_uri: The redirect URI to use. If not provided, the SWEATSTACK_REDIRECT_URI environment variable will be used.
         """
         self.client_id = client_id or os.environ.get("SWEATSTACK_CLIENT_ID")
         self.client_secret = client_secret or os.environ.get("SWEATSTACK_CLIENT_SECRET")
-        self.scope = scope or os.environ.get("SWEATSTACK_SCOPE")
+
+        if scopes is not None:
+            self.scopes = [Scope(scope.strip().lower()) if isinstance(scope, str) else scope
+                          for scope in scopes] if scopes else []
+        elif os.environ.get("SWEATSTACK_SCOPES"):
+            scopes = os.environ.get("SWEATSTACK_SCOPES").split(",")
+            self.scopes = [Scope(scope.strip().lower()) if isinstance(scope, str) else scope
+                          for scope in scopes]
+        else:
+            self.scopes = [Scope.data_read, Scope.profile]
+
         self.redirect_uri = redirect_uri or os.environ.get("SWEATSTACK_REDIRECT_URI")
 
         self.api_key = st.session_state.get("sweatstack_api_key")
@@ -81,7 +98,7 @@ class StreamlitAuth:
         params = {
             "client_id": self.client_id,
             "redirect_uri": self.redirect_uri,
-            "scope": "data:read",
+            "scope": ",".join([scope.value for scope in self.scopes]),
             "prompt": "none",
         }
         path = "/oauth/authorize"

{sweatstack-0.36.0 → sweatstack-0.38.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.36.0/src/sweatstack/schemas.py

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