PyPI - sweatstack - Versions diffs - 0.47.0__tar.gz → 0.49.0__tar.gz - Mend

sweatstack 0.47.0tar.gz → 0.49.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 (29) hide show

sweatstack-0.49.0/.claude/settings.local.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python:*)"
+    ],
+    "deny": []
+  }
+}

{sweatstack-0.47.0 → sweatstack-0.49.0}/CHANGELOG.md RENAMED Viewed

@@ -6,6 +6,20 @@ 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.49.0] - 2025-08-18
+### Added
+- Added a new `metrics` parameter to the `ss.get_activity_data()` and `ss.get_latest_activity_data()` methods that allows for filtering the data by specific metrics.
+## [0.48.0] - 2025-08-12
+### Added
+- Added optional local caching of longitudinal data, enabled by setting the `SWEATSTACK_CACHE_ENABLED` environment variable to `true`. The cache directory can be specified by setting the `SWEATSTACK_CACHE_DIR` environment variable. The cache can be cleared by calling `ss.clear_cache()`.
 ## [0.47.0] - 2025-08-07
 ### Added

{sweatstack-0.47.0 → sweatstack-0.49.0}/PKG-INFO RENAMED Viewed

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

{sweatstack-0.47.0 → sweatstack-0.49.0}/pyproject.toml RENAMED Viewed

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

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/client.py RENAMED Viewed

@@ -6,6 +6,8 @@ import hashlib
 import logging
 import os
 import secrets
+import shutil
+import tempfile
 import time
 import urllib
 import webbrowser
@@ -49,6 +51,110 @@ AUTH_SUCCESSFUL_RESPONSE = """<!DOCTYPE html>
 OAUTH2_CLIENT_ID = "5382f68b0d254378"
+class LocalCacheMixin:
+    """Mixin for handling local filesystem caching of API responses."""
+    def _cache_enabled(self) -> bool:
+        """Check if local caching is enabled."""
+        return bool(os.getenv("SWEATSTACK_LOCAL_CACHE"))
+    def _log_cache_error(self, operation: str, error: Exception) -> None:
+        """Log cache operation errors with context."""
+        cache_location = os.getenv("SWEATSTACK_CACHE_DIR") or tempfile.gettempdir()
+        try:
+            user_id = self._get_user_id_from_token()
+        except Exception:
+            user_id = "unknown"
+        logging.warning(
+            f"Failed to {operation} cache despite SWEATSTACK_LOCAL_CACHE being enabled. "
+            f"Cache directory: {cache_location}/sweatstack/{user_id}. "
+            f"Error: {error}"
+        )
+    def _get_user_id_from_token(self) -> str:
+        """Extract user ID from the JWT token."""
+        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")
+            return user_id
+        except Exception as e:
+            raise ValueError(f"Invalid authentication token: {e}")
+    def _get_cache_dir(self) -> Path:
+        """Get cache directory for current user."""
+        user_id = self._get_user_id_from_token()
+        if cache_location := os.getenv("SWEATSTACK_CACHE_DIR"):
+            cache_dir = Path(cache_location) / user_id
+        else:
+            cache_dir = Path(tempfile.gettempdir()) / "sweatstack" / user_id
+        cache_dir.mkdir(parents=True, exist_ok=True, mode=0o700)
+        return cache_dir
+    def _generate_longitudinal_cache_key(self, **params) -> str:
+        """Generate cache key for longitudinal data requests."""
+        normalized_params = {}
+        for key, value in params.items():
+            if value is None:
+                continue
+            elif isinstance(value, list):
+                normalized_params[key] = sorted([
+                    v.value if hasattr(v, 'value') else str(v) for v in value
+                ])
+            elif hasattr(value, 'value'):
+                normalized_params[key] = value.value
+            elif isinstance(value, (date, datetime)):
+                normalized_params[key] = value.isoformat()
+            else:
+                normalized_params[key] = str(value)
+        cache_data = f"longitudinal_data:{json.dumps(normalized_params, sort_keys=True)}"
+        return hashlib.sha256(cache_data.encode()).hexdigest()[:16]
+    def _read_longitudinal_cache(self, cache_key: str) -> pd.DataFrame | None:
+        """Try to read cached longitudinal data."""
+        try:
+            cache_dir = self._get_cache_dir()
+            cache_file = cache_dir / f"longitudinal-{cache_key}.parquet"
+            if cache_file.exists():
+                return pd.read_parquet(cache_file)
+        except Exception as e:
+            self._log_cache_error("read", e)
+        return None
+    def _write_longitudinal_cache(self, cache_key: str, content: bytes) -> None:
+        """Write longitudinal data to cache."""
+        try:
+            cache_dir = self._get_cache_dir()
+            cache_file = cache_dir / f"longitudinal-{cache_key}.parquet"
+            cache_file.write_bytes(content)
+        except Exception as e:
+            self._log_cache_error("write", e)
+    def clear_cache(self) -> None:
+        """Clear all cached data for the current user.
+        This removes all cached data (longitudinal data, etc.) from the temporary
+        directory for the currently authenticated user.
+        """
+        try:
+            cache_dir = self._get_cache_dir()
+            if cache_dir.exists():
+                shutil.rmtree(cache_dir)
+        except Exception as e:
+            self._log_cache_error("clear", e)
 class TokenStorageMixin:
     """Mixin for handling persistent token storage using platformdirs."""
@@ -434,7 +540,7 @@ class DelegationMixin:
         )
-class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
+class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin, LocalCacheMixin):
     def __init__(
         self,
         api_key: str | None = None,
@@ -723,6 +829,7 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
         self,
         activity_id: str,
         adaptive_sampling_on: Literal["power", "speed"] | None = None,
+        metrics: list[Metric | str] | None = None,
     ) -> pd.DataFrame:
         """Gets the raw data for a specific activity.
@@ -733,6 +840,7 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
             activity_id: The unique identifier of the activity.
             adaptive_sampling_on: Optional parameter to apply adaptive sampling on
                 either "power" or "speed" data. If None, no adaptive sampling is applied.
+            metrics: Optional list of metrics to include in the results. Can be a list of Metric enums or strings.
         Returns:
             pd.DataFrame: A pandas DataFrame containing the activity's time-series data.
@@ -743,6 +851,8 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
         params = {}
         if adaptive_sampling_on is not None:
             params["adaptive_sampling_on"] = adaptive_sampling_on
+        if metrics is not None:
+            params["metrics"] = self._enums_to_strings(metrics)
         with self._http_client() as client:
             response = client.get(
@@ -794,6 +904,7 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
         self,
         sport: Sport | str | None = None,
         adaptive_sampling_on: Literal["power", "speed"] | None = None,
+        metrics: list[Metric | str] | None = None,
     ) -> pd.DataFrame:
         """Gets the data for the latest activity of a specific sport.
@@ -804,6 +915,7 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
             sport: Optional sport to filter by. Can be a Sport enum or string.
             adaptive_sampling_on: Optional metric to apply adaptive sampling for visualization.
                 Can be either "power" or "speed". Defaults to None.
+            metrics: Optional list of metrics to include in the results. Can be a list of Metric enums or strings.
         Returns:
             pd.DataFrame: A pandas DataFrame containing the activity data.
@@ -812,7 +924,7 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
             HTTPStatusError: If the API request fails.
         """
         activity = self.get_latest_activity(sport=sport)
-        return self.get_activity_data(activity.id, adaptive_sampling_on)
+        return self.get_activity_data(activity.id, adaptive_sampling_on, metrics=metrics)
     def get_latest_activity_mean_max(
         self,
@@ -891,6 +1003,12 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
         if adaptive_sampling_on is not None:
             params["adaptive_sampling_on"] = self._enums_to_strings([adaptive_sampling_on])[0]
+        if self._cache_enabled():
+            cache_key = self._generate_longitudinal_cache_key(**params)
+            cached_df = self._read_longitudinal_cache(cache_key)
+            if cached_df is not None:
+                return self._postprocess_dataframe(cached_df)
         with self._http_client() as client:
             response = client.get(
                 url="/api/v1/activities/longitudinal-data",
@@ -898,8 +1016,12 @@ class Client(OAuth2Mixin, DelegationMixin, TokenStorageMixin):
             )
             self._raise_for_status(response)
+            if self._cache_enabled():
+                self._write_longitudinal_cache(cache_key, response.content)
             df = pd.read_parquet(BytesIO(response.content))
-            return self._postprocess_dataframe(df)
+        return self._postprocess_dataframe(df)
     def get_longitudinal_mean_max(
         self,
@@ -1359,6 +1481,7 @@ _generate_singleton_methods(
         "get_sports",
         "get_tags",
+        "clear_cache",
         "switch_user",
         "switch_back",

{sweatstack-0.47.0 → sweatstack-0.49.0}/.gitignore RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/.python-version RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/DEVELOPMENT.md RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/Makefile RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/README.md RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/.ipynb_checkpoints/Untitled-checkpoint.ipynb RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/README.md RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/Sweat Stack examples/Getting started.ipynb RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/Untitled.ipynb RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/hello.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/playground/pyproject.toml RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/Sweat Stack examples/Getting started.ipynb RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/__init__.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/cli.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/constants.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/ipython_init.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/jupyterlab_oauth2_startup.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/openapi_schemas.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/py.typed RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/schemas.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/streamlit.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/sweatshell.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/src/sweatstack/utils.py RENAMED Viewed

File without changes

{sweatstack-0.47.0 → sweatstack-0.49.0}/uv.lock RENAMED Viewed

File without changes

sweatstack 0.47.0__tar.gz → 0.49.0__tar.gz

sweatstack 0.47.0tar.gz → 0.49.0tar.gz