PyPI - sweatstack - Versions diffs - 0.43.0__tar.gz → 0.45.0__tar.gz - Mend

sweatstack 0.43.0tar.gz → 0.45.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

sweatstack-0.45.0/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,26 @@
+# 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.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.43.0 → sweatstack-0.45.0}/PKG-INFO RENAMED Viewed

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: sweatstack
-Version: 0.43.0
+Version: 0.45.0
 Summary: The official Python client for SweatStack
 Author-email: Aart Goossens <aart@gssns.io>
 Requires-Python: >=3.9
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pandas>=2.2.3
+Requires-Dist: platformdirs>=4.0.0
 Requires-Dist: pyarrow>=18.0.0
 Requires-Dist: pydantic>=2.10.5
 Provides-Extra: jupyter

{sweatstack-0.43.0 → sweatstack-0.45.0}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [project]
 name = "sweatstack"
-version = "0.43.0"
+version = "0.45.0"
 description = "The official Python client for SweatStack"
 readme = "README.md"
 authors = [
@@ -10,6 +10,7 @@ requires-python = ">=3.9"
 dependencies = [
     "httpx>=0.28.1",
     "pandas>=2.2.3",
+    "platformdirs>=4.0.0",
     "pyarrow>=18.0.0",
     "pydantic>=2.10.5",
 ]

{sweatstack-0.43.0 → sweatstack-0.45.0}/src/sweatstack/client.py RENAMED Viewed

@@ -1,5 +1,6 @@
 import base64
 import contextlib
+import json
 import random
 import hashlib
 import logging
@@ -14,11 +15,13 @@ from functools import wraps
 from http.server import BaseHTTPRequestHandler, HTTPServer
 from importlib.metadata import version
 from io import BytesIO
+from pathlib import Path
 from typing import Any, Generator, get_type_hints, List, Literal
 from urllib.parse import parse_qs, urlparse
 import httpx
 import pandas as pd
+from platformdirs import user_data_dir
 from .constants import DEFAULT_URL
 from .schemas import (
@@ -45,6 +48,45 @@ AUTH_SUCCESSFUL_RESPONSE = """<!DOCTYPE html>
 OAUTH2_CLIENT_ID = "5382f68b0d254378"
+class TokenStorageMixin:
+    """Mixin for handling persistent token storage using platformdirs."""
+    def _get_token_file_path(self) -> Path:
+        """Get the path to the token storage file."""
+        data_dir = user_data_dir("SweatStack", "SweatStack")
+        return Path(data_dir) / "tokens.json"
+    def _save_tokens(self, access_token: str, refresh_token: str) -> None:
+        """Save tokens to the user data directory."""
+        token_file = self._get_token_file_path()
+        token_file.parent.mkdir(parents=True, exist_ok=True)
+        token_data = {
+            "access_token": access_token,
+            "refresh_token": refresh_token
+        }
+        with open(token_file, "w") as f:
+            json.dump(token_data, f, indent=2)
+        # Set restrictive permissions (user read/write only)
+        token_file.chmod(0o600)
+    def _load_persistent_tokens(self) -> tuple[str | None, str | None]:
+        """Load tokens from the user data directory."""
+        token_file = self._get_token_file_path()
+        if not token_file.exists():
+            return None, None
+        try:
+            with open(token_file, "r") as f:
+                token_data = json.load(f)
+            return token_data.get("access_token"), token_data.get("refresh_token")
+        except (json.JSONDecodeError, FileNotFoundError, KeyError):
+            return None, None
 try:
     __version__ = version("sweatstack")
 except ImportError:
@@ -52,7 +94,7 @@ except ImportError:
 class OAuth2Mixin:
-    def login(self):
+    def login(self, persist_api_key: bool = True):
         """Initiates the OAuth2 login flow for SweatStack authentication.
         This method starts a local HTTP server to receive the OAuth2 callback,
@@ -62,6 +104,10 @@ class OAuth2Mixin:
         The method uses PKCE (Proof Key for Code Exchange) for enhanced security
         during the OAuth2 authorization code flow.
+        Args:
+            persist_api_key: Whether to save the API key to persistent storage for future use.
+                Defaults to True.
         Returns:
             None
@@ -144,10 +190,45 @@ class OAuth2Mixin:
             self.jwt = token_response.get("access_token")
             self.api_key = self.jwt
             self.refresh_token = token_response.get("refresh_token")
+            if persist_api_key:
+                self._save_tokens(self.api_key, self.refresh_token)
             print(f"SweatStack Python login successful.")
         else:
             raise Exception("SweatStack Python login failed. Please try again.")
+    def authenticate(self, *, persist_api_key: bool = True, force_login: bool = False) -> None:
+        """Ensures the client is authenticated, either using existing tokens or by initiating login.
+        This method checks for authentication in the following order:
+        1. Current instance tokens (if already set)
+        2. Environment variables (SWEATSTACK_API_KEY, SWEATSTACK_REFRESH_TOKEN)
+        3. Persistent storage tokens
+        4. If none found or force_login is True, initiates OAuth2 login flow
+        Args:
+            persist_api_key: Whether to save tokens to persistent storage after login.
+                Defaults to True.
+            force_login: Whether to force a new login even if tokens are available.
+                Defaults to False.
+        Returns:
+            None
+        Raises:
+            Exception: If the authentication process fails.
+        """
+        if force_login:
+            self.login(persist_api_key=persist_api_key)
+            return
+        # Check if we already have valid tokens
+        if self.api_key:
+            return
+        # If no tokens available, initiate login
+        self.login(persist_api_key=persist_api_key)
 class DelegationMixin:
     def _validate_user(self, user: str | UserSummary):
@@ -352,7 +433,7 @@ class DelegationMixin:
         )
-class Client(OAuth2Mixin, DelegationMixin):
+class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
     def __init__(
         self,
         api_key: str | None = None,
@@ -399,8 +480,10 @@ class Client(OAuth2Mixin, DelegationMixin):
     def api_key(self) -> str:
         if self._api_key is not None:
             value = self._api_key
+        elif value := os.getenv("SWEATSTACK_API_KEY"):
+            pass
         else:
-            value = os.getenv("SWEATSTACK_API_KEY")
+            value, _ = self._load_persistent_tokens()
         if value is None:
             # A non-authenticated client is a potentially valid use-case.
@@ -416,8 +499,12 @@ class Client(OAuth2Mixin, DelegationMixin):
     def refresh_token(self) -> str:
         if self._refresh_token is not None:
             return self._refresh_token
+        elif value := os.getenv("SWEATSTACK_REFRESH_TOKEN"):
+            pass
         else:
-            return os.getenv("SWEATSTACK_REFRESH_TOKEN")
+            _, value = self._load_persistent_tokens()
+        return value
     @refresh_token.setter
     def refresh_token(self, value: str):
@@ -1117,6 +1204,32 @@ class Client(OAuth2Mixin, DelegationMixin):
             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()
@@ -1156,10 +1269,12 @@ def _generate_singleton_methods(method_names: List[str]) -> None:
 _generate_singleton_methods(
     [
         "login",
+        "authenticate",
         "get_user",
         "get_users",
         "get_userinfo",
+        "whoami",
         "get_activities",

{sweatstack-0.43.0 → sweatstack-0.45.0}/src/sweatstack/ipython_init.py RENAMED Viewed

@@ -1,12 +1,8 @@
-import time
 import sweatstack as ss
 print("\n")
 print(">>>>>>>>>> Sweat Stack Initialization <<<<<<<<<")
 print("Initializing....")
-print("You will be redirected to your browser for authentication.\n")
-time.sleep(2)
-ss.login()
+ss.authenticate()

{sweatstack-0.43.0 → sweatstack-0.45.0}/src/sweatstack/jupyterlab_oauth2_startup.py RENAMED Viewed

@@ -5,7 +5,6 @@ from pathlib import Path
 import sweatstack as ss
 from jupyterlab.labapp import LabApp
-from sweatstack.client import _default_client
 def start_jupyterlab_with_oauth():
@@ -24,9 +23,7 @@ def start_jupyterlab_with_oauth():
         if not target_dir.exists():
             shutil.copytree(examples_dir, target_dir)
-    ss.login()
-    os.environ["SWEATSTACK_API_KEY"] = _default_client.api_key
-    os.environ["SWEATSTACK_REFRESH_TOKEN"] = _default_client.refresh_token
+    ss.authenticate()
     return LabApp.launch_instance(argv=remaining_args)

{sweatstack-0.43.0 → sweatstack-0.45.0}/src/sweatstack/schemas.py RENAMED Viewed

@@ -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