sweatstack 0.11.1__py3-none-any.whl → 0.13.0__py3-none-any.whl

sweatstack/streamlit.py

@@ -0,0 +1,116 @@
+import hashlib
+import base64
+import os
+import secrets
+import urllib.parse
+
+try:
+    import streamlit as st
+except ImportError:
+    raise ImportError(
+        "Streamlit features require streamlit to be installed. "
+        "You can install it with:\n\n"
+        "pip install 'sweatstack[streamlit]'\n\n"
+    )
+import httpx
+from streamlit_cookies_controller import CookieController
+from sweatstack import Client
+
+from .constants import DEFAULT_URL
+
+
+cookie_controller = CookieController()
+
+
+class StreamlitAuth:
+    def __init__(self, set_env_var=False, client_id=None, client_secret=None, scope=None, redirect_uri=None):
+        """
+        Args:
+            set_env_var: Whether to set the SWEATSTACK_API_KEY environment variable. Default is False.
+            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.
+            redirect_uri: The redirect URI to use. If not provided, the SWEATSTACK_REDIRECT_URI environment variable will be used.
+        """
+        self.set_env_var = set_env_var
+        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")
+        self.redirect_uri = redirect_uri or os.environ.get("SWEATSTACK_REDIRECT_URI")
+
+        self.api_key = cookie_controller.get("sweatstack_api_key")
+        self.client = Client(self.api_key)
+
+        if self.api_key and self.set_env_var:
+            os.environ["SWEATSTACK_API_KEY"] = self.api_key
+
+    def _show_sweatstack_logout(self):
+        if st.button("Logout"):
+            self.api_key = None
+            self.client = Client()
+            cookie_controller.remove("sweatstack_api_key")
+            if self.set_env_var:
+                os.environ.pop("SWEATSTACK_API_KEY")
+
+    def _show_sweatstack_login(self):
+        st.link_button("Login", self._get_authorization_url_implicit())
+
+    def _get_authorization_url_implicit(self):
+        code_verifier = secrets.token_urlsafe(32)
+        cookie_controller.set("code_verifier", code_verifier)
+        code_challenge = hashlib.sha256(code_verifier.encode("ascii")).digest()
+        code_challenge = base64.urlsafe_b64encode(code_challenge).rstrip(b"=").decode("ascii")
+
+        params = {
+            "client_id": self.client_id,
+            "redirect_uri": self.redirect_uri,
+            "code_challenge": code_challenge,
+            "scope": "data:read",
+        }
+        path = "/oauth/authorize"
+        authorization_url = urllib.parse.urljoin(DEFAULT_URL, path + "?" + urllib.parse.urlencode(params))
+
+        return authorization_url
+
+
+    def _exchange_token_implicit(self, code):
+        code_verifier = cookie_controller.get("code_verifier")
+        token_data = {
+            "grant_type": "authorization_code",
+            "client_id": self.client_id,
+            "code": code,
+            "code_verifier": code_verifier
+        }
+        response = httpx.post(
+            f"{DEFAULT_URL}/oauth/token",
+            data=token_data,
+        )
+        try:
+            response.raise_for_status()
+        except httpx.HTTPStatusError as e:
+            raise Exception(f"SweatStack Python login failed. Please try again.") from e
+        token_response = response.json()
+
+        self.api_key = token_response.get("access_token")
+        cookie_controller.set("sweatstack_api_key", self.api_key)
+        if self.set_env_var:
+            os.environ["SWEATSTACK_API_KEY"] = self.api_key
+
+        self.client = Client(self.api_key)
+
+        cookie_controller.remove("code_verifier")
+
+        return
+
+    def is_authenticated(self):
+        return self.api_key is not None
+
+    def authenticate(self):
+        if self.is_authenticated():
+            self._show_sweatstack_logout()
+        elif code := st.query_params.get("code"):
+            self._exchange_token_implicit(code)
+            st.query_params.clear()
+            st.rerun()
+        else:
+            self._show_sweatstack_login()

sweatstack/utils.py

@@ -0,0 +1,13 @@
+import base64
+import json
+
+
+def decode_jwt_body(jwt: str) -> dict:
+    payload = jwt.split(".")[1]
+    
+    padding = len(payload) % 4
+    if padding:
+        payload += "=" * (4 - padding)
+        
+    decoded = base64.urlsafe_b64decode(payload)
+    return json.loads(decoded)

sweatstack-0.13.0.dist-info/METADATA

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: sweatstack
+Version: 0.13.0
+Summary: The official Python client for SweatStack
+Author-email: Aart Goossens <aart@gssns.io>
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyarrow>=19.0.0
+Requires-Dist: pydantic>=2.10.5
+Provides-Extra: jupyterlab
+Requires-Dist: ipython>=8.31.0; extra == 'jupyterlab'
+Requires-Dist: jupyterlab>=4.3.4; extra == 'jupyterlab'
+Requires-Dist: matplotlib; extra == 'jupyterlab'
+Provides-Extra: streamlit
+Requires-Dist: streamlit-cookies-controller>=0.0.4; extra == 'streamlit'
+Requires-Dist: streamlit>=1.42.0; extra == 'streamlit'
+Description-Content-Type: text/markdown
+
+# SweatStack Python client library
+
+
+# Quickstart
+
+```
+uv pip install sweatstack
+```
+
+```python
+import sweatstack as ss
+
+ss.login()
+
+ss.list_activities()
+```
+
+
+# Authentication
+
+SweatStack supports three authentication methods:
+
+### 1. Browser-Based OAuth2 Authentication
+```python
+ss.login()  # Opens your default browser for authentication
+```
+
+### 2. Direct API Key Authentication
+```python
+client = ss.Client(api_key="your-api-key")
+```
+
+### 3. Environment Variable
+Set the `SWEATSTACK_API_KEY` environment variable:
+```bash
+export SWEATSTACK_API_KEY="your-api-key"
+```
+
+SweatStack follows this priority order:
+
+1. Browser-based OAuth2 (`ss.login()`)
+2. Direct API key via `Client` constructor
+3. `SWEATSTACK_API_KEY` environment variable
+
+For example, calling `ss.login()` or `client.login()` will override any existing API key authentication, including those set through the constructor or environment variables.
+
+
+## Interfaces: Singleton vs Class-based
+
+This library provides both a singleton interface and a class-based interface.
+
+Singleton interface:
+```python
+import sweatstack as ss
+
+activities = ss.list_activities()
+```
+
+Class-based interface:
+```python
+from sweatstack import Client
+
+client = Client()
+activities = client.list_activities()
+```
+
+Although both interfaces are feature-equivalent, they serve different purposes:
+- The singleton interface is the default and recommended interface. It is intended for most use cases and is the easiest to use.
+- The class-based interface is intended for more advanced use cases, such as when you need to authenticate multiple users at the same time or in multi-threaded applications.
+
+
+## Streamlit integration
+
+The `sweatstack.streamlit` module provides a Streamlit integration for SweatStack. This requires the optional `streamlit` dependency that can be installed with:
+```
+uv pip install 'sweatstack[streamlit]'
+```
+
+The `StreamlitAuth` class is a Streamlit component that handles the OAuth2 authentication flow. It provides a `st.authenticate()` function that can be used to authenticate the user.
+
+Example usage:
+
+```python
+from sweatstack.streamlit import StreamlitAuth
+
+auth = StreamlitAuth()
+
+with st.sidebar:
+    st.authenticate()
+
+if not auth.is_authenticated():
+    st.write("User is not authenticated")
+    st.stop()
+
+st.write("User is authenticated")
+
+auth.client.get_latest_activity()
+```

sweatstack-0.13.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+sweatstack/__init__.py,sha256=tiVfgKlswRPaDMEy0gA7u8rveqEYZTA_kyB9lJ3J6Sc,21
+sweatstack/cli.py,sha256=N1NWOgEZR2yaJvIXxo9qvp_jFlypZYb0nujpbVNYQ6A,720
+sweatstack/client.py,sha256=gPWThdmLj3s6pKafzEfzV19PDb5x8AKLhuVlO50nmv8,19090
+sweatstack/constants.py,sha256=fGO6ksOv5HeISv9lHRoYm4besW1GTveXS8YD3K0ljg0,41
+sweatstack/ipython_init.py,sha256=zBGUlMFkdpLvsNpOpwrNaKRUpUZhzaICvH8ODJgMPcI,229
+sweatstack/jupyterlab_oauth2_startup.py,sha256=eZ6xi0Sa4hO4vUanimq0SqjduHtiywCURSDNWk_I-7s,1200
+sweatstack/openapi_schemas.py,sha256=vtYHa6A0kADFbd_jK1O7Kbn8YkbPfzaIwsRDDYjYeSA,13038
+sweatstack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sweatstack/schemas.py,sha256=CdkeV6IRmIuvxae7C5dz-hVlb6hkzEYfqKHHgVJprmY,90
+sweatstack/streamlit.py,sha256=cF2LZa2HY43lxwUby7XR5U71h7oibMtAurSVoxNDheM,4294
+sweatstack/sweatshell.py,sha256=MYLNcWbOdceqKJ3S0Pe8dwHXEeYsGJNjQoYUXpMTftA,333
+sweatstack/utils.py,sha256=0DcvHV1EOHQnN5OlfYo2DRrw8a9-6YkxTjLVCfi5ylE,277
+sweatstack-0.13.0.dist-info/METADATA,sha256=NTEPb9QMqBXEtiiZulqlnR0DPJHr2ElgGPdamJqG7Vc,3039
+sweatstack-0.13.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sweatstack-0.13.0.dist-info/entry_points.txt,sha256=kCzOUQI3dqbTpEYqtgYDeiKFaqaA7BMlV6D24BMzCFU,208
+sweatstack-0.13.0.dist-info/RECORD,,

{sweatstack-0.11.1.dist-info → sweatstack-0.13.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any