sweatstack 0.44.0__tar.gz → 0.46.0__tar.gz

sweatstack-0.46.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.46.0] - 2025-08-01
+
+### Added
+
+- Added a new `registered_at` field to the `UserInfoResponse` model that is returned by `ss.get_userinfo()`. This field is the timestamp of the user's registration with SweatStack.
+
+
+
+## [0.45.0] - 2025-06-24
+
+### Added
+
+- Added a new `ss.whoami()` method that returns the authenticated user's summary information. This method is recommended over `ss.get_userinfo()` which only exists for OpenID compatibility and requires the `profile` scope.
+- Added a new `ss.Metric.display_name()` method that returns a human-readable display name for a metric. For example, `ss.Metric.heart_rate.display_name()` returns "heart rate".
+
+## [0.44.0] - 2025-06-18
+
+### Added
+
+- Added support for persistent storage of API keys and refresh tokens.
+- Added a new `ss.authenticate()` method that handles authentication comprehensively, including calling `ss.login()` when needed. This method is now the recommended way to authenticate the client.
+
+
+## Changed
+
+- The `sweatlab` and `sweatshell` commands now use the new `ss.authenticate()` method.

{sweatstack-0.44.0 → sweatstack-0.46.0}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: sweatstack
-Version: 0.44.0
+Version: 0.46.0
 Summary: The official Python client for SweatStack
 Author-email: Aart Goossens <aart@gssns.io>
 Requires-Python: >=3.9
+Requires-Dist: email-validator>=2.2.0
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: platformdirs>=4.0.0

{sweatstack-0.44.0 → sweatstack-0.46.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sweatstack"
-version = "0.44.0"
+version = "0.46.0"
 description = "The official Python client for SweatStack"
 readme = "README.md"
 authors = [
@@ -8,6 +8,7 @@ authors = [
 ]
 requires-python = ">=3.9"
 dependencies = [
+    "email-validator>=2.2.0",
     "httpx>=0.28.1",
     "pandas>=2.2.3",
     "platformdirs>=4.0.0",

{sweatstack-0.44.0 → sweatstack-0.46.0}/src/sweatstack/client.py

@@ -1204,6 +1204,32 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
             self._raise_for_status(response)
             return UserInfoResponse.model_validate(response.json())
 
+    def whoami(self) -> UserSummary:
+        """Gets the authenticated user's summary information.
+
+        This method retrieves basic information about the currently authenticated user
+        by extracting the user ID from the JWT token and fetching the user details.
+
+        Returns:
+            UserSummary: A UserSummary object containing the authenticated user's information.
+
+        Raises:
+            ValueError: If no authentication token is available.
+            HTTPStatusError: If the API request fails or user is not found.
+        """
+        if not self.api_key:
+            raise ValueError("Not authenticated. Please call authenticate() or login() first.")
+
+        try:
+            jwt_body = decode_jwt_body(self.api_key)
+            user_id = jwt_body.get("sub")
+            if not user_id:
+                raise ValueError("Unable to extract user ID from token")
+        except Exception as e:
+            raise ValueError(f"Invalid authentication token: {e}")
+
+        return self._get_user_by_id(user_id)
+
 
 _default_client = Client()
 
@@ -1248,6 +1274,7 @@ _generate_singleton_methods(
         "get_user",
         "get_users",
         "get_userinfo",
+        "whoami",
 
         "get_activities",
 

{sweatstack-0.44.0 → sweatstack-0.46.0}/src/sweatstack/openapi_schemas.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2025-04-15T12:24:50+00:00
+#   timestamp: 2025-08-01T16:59:37+00:00
 
 from __future__ import annotations
 
@@ -8,19 +8,44 @@ from datetime import datetime, timedelta
 from enum import Enum
 from typing import List, Literal, Optional, Union
 
-from pydantic import AnyUrl, BaseModel, Field, SecretStr, confloat, conint
+from pydantic import (
+    AnyUrl,
+    BaseModel,
+    EmailStr,
+    Field,
+    RootModel,
+    SecretStr,
+    confloat,
+    conint,
+)
+
+
+class Activity(BaseModel):
+    id: str = Field(..., title='Id')
+    start_date_local: datetime = Field(..., title='Start Date Local')
 
 
 class ActivityUpdate(BaseModel):
     tags: Optional[List[str]] = Field(None, title='Tags')
 
 
+class Prompt(Enum):
+    none = 'none'
+    login = 'login'
+    consent = 'consent'
+    select_account = 'select_account'
+
+
+class BodyAddEmailPartialsAddEmailPost(BaseModel):
+    email: EmailStr = Field(..., title='Email')
+
+
 class BodyCreateApplicationApplicationsPost(BaseModel):
     name: str = Field(..., title='Name')
     description: str = Field(..., title='Description')
     url: AnyUrl = Field(..., title='Url')
     image: AnyUrl = Field(..., title='Image')
-    redirect_uris: List[AnyUrl] = Field(..., title='Redirect Uris')
+    redirect_uris: List[str] = Field(..., title='Redirect Uris')
     privacy_statement: AnyUrl = Field(..., title='Privacy Statement')
     published: Optional[bool] = Field(False, title='Published')
 
@@ -133,6 +158,7 @@ class Tz(Enum):
     America_Coral_Harbour = 'America/Coral_Harbour'
     America_Cordoba = 'America/Cordoba'
     America_Costa_Rica = 'America/Costa_Rica'
+    America_Coyhaique = 'America/Coyhaique'
     America_Creston = 'America/Creston'
     America_Cuiaba = 'America/Cuiaba'
     America_Curacao = 'America/Curacao'
@@ -635,13 +661,13 @@ class Tz(Enum):
 
 
 class BodyLoginPostLoginPost(BaseModel):
-    email: str = Field(..., title='Email')
+    email: EmailStr = Field(..., title='Email')
     password: SecretStr = Field(..., title='Password')
     tz: Tz = Field(..., title='Tz')
 
 
 class BodyRegisterPostRegisterPost(BaseModel):
-    email: str = Field(..., title='Email')
+    email: EmailStr = Field(..., title='Email')
     password: SecretStr = Field(..., title='Password')
     tz: Tz = Field(..., title='Tz')
 
@@ -654,12 +680,17 @@ class BodySaveOrUpdateIntegrationProviderTenantsTenantIdIntegrationProvidersInte
     redirect_url: str = Field(..., title='Redirect Url')
 
 
+class BodySendVerificationEmailPartialsSendVerificationEmailPost(BaseModel):
+    email: EmailStr = Field(..., title='Email')
+    tz: Tz = Field(..., title='Tz')
+
+
 class BodyUpdateApplicationApplicationsApplicationIdPut(BaseModel):
     name: str = Field(..., title='Name')
     description: str = Field(..., title='Description')
     url: AnyUrl = Field(..., title='Url')
     image: AnyUrl = Field(..., title='Image')
-    redirect_uris: List[AnyUrl] = Field(..., title='Redirect Uris')
+    redirect_uris: List[str] = Field(..., title='Redirect Uris')
     privacy_statement: AnyUrl = Field(..., title='Privacy Statement')
     published: Optional[bool] = Field(False, title='Published')
 
@@ -669,6 +700,10 @@ class BodyUpdateUserUsersUserIdPut(BaseModel):
     last_name: str = Field(..., title='Last Name')
 
 
+class BodyUploadActivityFileApiV1ActivitiesUploadPost(BaseModel):
+    files: List[bytes] = Field(..., max_length=10, title='Files')
+
+
 class BodyUploadActivityFileDataUploadPost(BaseModel):
     files: List[bytes] = Field(..., title='Files')
 
@@ -690,6 +725,13 @@ class ElevationSummary(BaseModel):
     max: Optional[int] = Field(None, title='Max')
 
 
+class GarminBackfillBody(BaseModel):
+    start: datetime = Field(..., title='Start')
+    end: datetime = Field(..., title='End')
+    user_id__in: Optional[List[str]] = Field(None, title='User Id  In')
+    user_id__not_in: Optional[List[str]] = Field(None, title='User Id  Not In')
+
+
 class GarminDeregistration(BaseModel):
     userId: str = Field(..., title='Userid')
     userAccessToken: str = Field(..., title='Useraccesstoken')
@@ -718,8 +760,33 @@ class HeartRateSummary(BaseModel):
     end: Optional[float] = Field(None, title='End')
 
 
+class Instruction(BaseModel):
+    type: Literal['instruction'] = Field('instruction', title='Type')
+    text: str = Field(..., title='Text')
+
+
 class IntegrationName(Enum):
     garmin_connect = 'garmin_connect'
+    intervals_icu = 'intervals_icu'
+
+
+class IntensityQuantity(Enum):
+    speed = 'speed'
+    power = 'power'
+
+
+class IntervalsIcuWebhookEventType(Enum):
+    APP_SCOPE_CHANGED = 'APP_SCOPE_CHANGED'
+    CALENDAR_UPDATED = 'CALENDAR_UPDATED'
+    CALENDAR_EVENT_UPDATED = 'CALENDAR_EVENT_UPDATED'
+    CALENDAR_EVENT_DELETED = 'CALENDAR_EVENT_DELETED'
+    ACTIVITY_UPLOADED = 'ACTIVITY_UPLOADED'
+    ACTIVITY_ANALYZED = 'ACTIVITY_ANALYZED'
+    ACTIVITY_UPDATED = 'ACTIVITY_UPDATED'
+    ACTIVITY_DELETED = 'ACTIVITY_DELETED'
+    ACTIVITY_ACHIEVEMENTS = 'ACTIVITY_ACHIEVEMENTS'
+    WELLNESS_UPDATED = 'WELLNESS_UPDATED'
+    FITNESS_UPDATED = 'FITNESS_UPDATED'
 
 
 class Metric(Enum):
@@ -748,6 +815,16 @@ class PowerSummary(BaseModel):
     max: Optional[float] = Field(None, title='Max')
 
 
+class Reference(Enum):
+    absolute = 'absolute'
+    tte = 'tte'
+    parameter = 'parameter'
+
+
+class RepeatQuantity(Enum):
+    number = 'number'
+
+
 class Scope(Enum):
     data_read = 'data:read'
     data_write = 'data:write'
@@ -819,6 +896,22 @@ class TemperatureSummary(BaseModel):
     max: Optional[float] = Field(None, title='Max')
 
 
+class TemplateDay(BaseModel):
+    sports: List[Sport] = Field(..., title='Sports')
+    avg_training_duration: timedelta = Field(..., title='Avg Training Duration')
+    typical_training_duration: timedelta = Field(..., title='Typical Training Duration')
+
+
+class TemplateWeekResponse(BaseModel):
+    monday: TemplateDay
+    tuesday: TemplateDay
+    wednesday: TemplateDay
+    thursday: TemplateDay
+    friday: TemplateDay
+    saturday: TemplateDay
+    sunday: TemplateDay
+
+
 class TokenRequest(BaseModel):
     grant_type: GrantType
     client_id: Optional[str] = Field(None, title='Client Id')
@@ -850,11 +943,18 @@ class TraceCreateOrUpdate(BaseModel):
     sport: Optional[Sport] = None
 
 
+class UserFlow(Enum):
+    session = 'session'
+    signup = 'signup'
+    login = 'login'
+
+
 class UserInfoResponse(BaseModel):
     sub: str = Field(..., title='Sub')
     given_name: Optional[str] = Field(None, title='Given Name')
     family_name: Optional[str] = Field(None, title='Family Name')
     email: Optional[str] = Field(None, title='Email')
+    registered_at: datetime = Field(..., title='Registered At')
     name: str = Field(..., title='Name')
 
 
@@ -872,6 +972,17 @@ class ValidationError(BaseModel):
     type: str = Field(..., title='Error Type')
 
 
+class Value(BaseModel):
+    reference: Reference
+    value: Union[int, float] = Field(..., title='Value')
+    parameter: Optional[str] = Field(None, title='Parameter')
+
+
+class VolumeQuantity(Enum):
+    duration = 'duration'
+    distance = 'distance'
+
+
 class ActivitySummarySummary(BaseModel):
     power: Optional[PowerSummary] = None
     speed: Optional[SpeedSummary] = None
@@ -883,6 +994,18 @@ class ActivitySummarySummary(BaseModel):
     smo2: Optional[Smo2Summary] = None
 
 
+class AuthorizeQueryParams(BaseModel):
+    client_id: str = Field(..., title='Client Id')
+    redirect_uri: Optional[str] = Field(None, title='Redirect Uri')
+    scope: List[Scope] = Field(..., min_length=1, title='Scope')
+    state: Optional[str] = Field(None, title='State')
+    nonce: Optional[str] = Field(None, title='Nonce')
+    code_challenge: Optional[str] = Field(None, title='Code Challenge')
+    code_challenge_method: Optional[str] = Field(None, title='Code Challenge Method')
+    prompt: Optional[Prompt] = Field('consent', title='Prompt')
+    user_flow: Optional[UserFlow] = 'session'
+
+
 class BodyAuthorizeOauthAuthorizePost(BaseModel):
     client_id: str = Field(..., title='Client Id')
     redirect_uri: Optional[str] = Field(None, title='Redirect Uri')
@@ -893,10 +1016,32 @@ class BodyAuthorizeOauthAuthorizePost(BaseModel):
     code_challenge_method: Optional[str] = Field(None, title='Code Challenge Method')
 
 
+class BodyExpressAddEmailPostExpressAddEmailPost(BaseModel):
+    email: EmailStr = Field(..., title='Email')
+    state: Optional[str] = Field(None, title='State')
+    user_flow: Optional[UserFlow] = 'session'
+
+
 class BodyGenerateApiKeyPartialsGenerateApiKeyPost(BaseModel):
     scopes: List[Scope] = Field(..., title='Scopes')
 
 
+class ConstantValueInput(BaseModel):
+    type: Literal['constant'] = Field('constant', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    value: Value
+
+
+class ConstantValueOutput(BaseModel):
+    type: Literal['constant'] = Field('constant', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    value: Value
+
+
 class DelegatedTokenRequest(BaseModel):
     sub: str = Field(..., title='Sub')
     scopes: Optional[List[Scope]] = Field(None, title='Scopes')
@@ -922,6 +1067,13 @@ class HTTPValidationError(BaseModel):
     detail: Optional[List[ValidationError]] = Field(None, title='Detail')
 
 
+class IntervalsIcuWebhookEvent(BaseModel):
+    athlete_id: str = Field(..., title='Athlete Id')
+    type: IntervalsIcuWebhookEventType
+    timestamp: datetime = Field(..., title='Timestamp')
+    activity: Activity
+
+
 class Lap(BaseModel):
     power: Optional[PowerSummary] = None
     speed: Optional[SpeedSummary] = None
@@ -938,6 +1090,155 @@ class Lap(BaseModel):
     end_local: datetime = Field(..., title='End Local')
 
 
+class RampValueInput(BaseModel):
+    type: Literal['ramp'] = Field('ramp', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    start: Value
+    end: Value
+
+
+class RampValueOutput(BaseModel):
+    type: Literal['ramp'] = Field('ramp', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    start: Value
+    end: Value
+
+
+class RangeValueInput(BaseModel):
+    type: Literal['range'] = Field('range', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    min: Optional[Value] = None
+    max: Optional[Value] = None
+
+
+class RangeValueOutput(BaseModel):
+    type: Literal['range'] = Field('range', title='Type')
+    quantity: Union[VolumeQuantity, IntensityQuantity, RepeatQuantity] = Field(
+        ..., title='Quantity'
+    )
+    min: Optional[Value] = None
+    max: Optional[Value] = None
+
+
+class IntervalInput(BaseModel):
+    type: Literal['interval'] = Field('interval', title='Type')
+    volume: Union[ConstantValueInput, RangeValueInput, RampValueInput] = Field(
+        ..., discriminator='type', title='Volume'
+    )
+    intensity: Union[ConstantValueInput, RangeValueInput, RampValueInput] = Field(
+        ..., discriminator='type', title='Intensity'
+    )
+
+
+class IntervalOutput(BaseModel):
+    type: Literal['interval'] = Field('interval', title='Type')
+    volume: Union[ConstantValueOutput, RangeValueOutput, RampValueOutput] = Field(
+        ..., discriminator='type', title='Volume'
+    )
+    intensity: Union[ConstantValueOutput, RangeValueOutput, RampValueOutput] = Field(
+        ..., discriminator='type', title='Intensity'
+    )
+
+
+class IntervalsIcuWebhookBody(BaseModel):
+    secret: str = Field(..., title='Secret')
+    events: List[IntervalsIcuWebhookEvent] = Field(..., title='Events')
+
+
+class RepeatInput(BaseModel):
+    type: Literal['repeat'] = Field(..., title='Type')
+    count: Union[ConstantValueInput, RangeValueInput] = Field(
+        ..., discriminator='type', title='Count'
+    )
+    content: List[Union[IntervalInput, RepeatInput, Instruction]] = Field(
+        ..., title='Content'
+    )
+
+
+class RepeatOutput(BaseModel):
+    type: Literal['repeat'] = Field(..., title='Type')
+    count: Union[ConstantValueOutput, RangeValueOutput] = Field(
+        ..., discriminator='type', title='Count'
+    )
+    content: List[Union[IntervalOutput, RepeatOutput, Instruction]] = Field(
+        ..., title='Content'
+    )
+
+
+class SectionInput(BaseModel):
+    type: Literal['section'] = Field('section', title='Type')
+    name: Optional[str] = Field(..., title='Name')
+    content: List[Union[IntervalInput, RepeatInput, Instruction]] = Field(
+        ..., title='Content'
+    )
+
+
+class SectionOutput(BaseModel):
+    type: Literal['section'] = Field('section', title='Type')
+    name: Optional[str] = Field(..., title='Name')
+    content: List[Union[IntervalOutput, RepeatOutput, Instruction]] = Field(
+        ..., title='Content'
+    )
+
+
+class Content(RootModel[Union[IntervalInput, RepeatInput, SectionInput, Instruction]]):
+    root: Union[IntervalInput, RepeatInput, SectionInput, Instruction] = Field(
+        ..., discriminator='type'
+    )
+
+
+class WorkoutInput(BaseModel):
+    version: Optional[str] = Field('0.1.0', title='Version')
+    title: Optional[str] = Field(None, title='Title')
+    description: Optional[str] = Field(None, title='Description')
+    content: List[Content] = Field(..., title='Content')
+
+
+class Content1(
+    RootModel[Union[IntervalOutput, RepeatOutput, SectionOutput, Instruction]]
+):
+    root: Union[IntervalOutput, RepeatOutput, SectionOutput, Instruction] = Field(
+        ..., discriminator='type'
+    )
+
+
+class WorkoutOutput(BaseModel):
+    version: Optional[str] = Field('0.1.0', title='Version')
+    title: Optional[str] = Field(None, title='Title')
+    description: Optional[str] = Field(None, title='Description')
+    content: List[Content1] = Field(..., title='Content')
+
+
+class LibraryWorkoutCreate(BaseModel):
+    swf: WorkoutInput
+    sport: Sport
+
+
+class LibraryWorkoutResponse(BaseModel):
+    id: str = Field(..., title='Id')
+    swf: WorkoutOutput
+    sport: Sport
+
+
+class ScheduledWorkoutCreate(BaseModel):
+    swf: WorkoutInput
+    sport: Sport
+    start: datetime = Field(..., title='Start')
+
+
+class ScheduledWorkoutResponse(BaseModel):
+    id: str = Field(..., title='Id')
+    swf: WorkoutOutput
+    sport: Sport
+    start: Optional[datetime] = Field(..., title='Start')
+
+
 class ActivityDetails(BaseModel):
     tags: Optional[List[str]] = Field(None, title='Tags')
     id: str = Field(..., title='Id')
@@ -987,5 +1288,7 @@ class TraceDetails(BaseModel):
     timestamp_local: datetime = Field(..., title='Timestamp Local')
 
 
+RepeatInput.model_rebuild()
+RepeatOutput.model_rebuild()
 ActivityDetails.model_rebuild()
 ActivitySummary.model_rebuild()

{sweatstack-0.44.0 → sweatstack-0.46.0}/src/sweatstack/schemas.py

@@ -101,4 +101,15 @@ def display_name(sport: Sport) -> str:
 Sport.root_sport = root_sport
 Sport.parent_sport = parent_sport
 Sport.is_sub_sport_of = is_sub_sport_of
-Sport.display_name = display_name
+Sport.display_name = display_name
+
+
+def metric_display_name(metric: Metric) -> str:
+    """Returns a human-readable display name for a metric.
+
+    This function converts a Metric enum value into a formatted string suitable for display.
+    """
+    return metric.value.replace("_", " ")
+
+
+Metric.display_name = metric_display_name