SweatStack Python client library

Quickstart

uv pip install sweatstack

import sweatstack as ss

ss.login()

ss.list_activities()

Authentication

SweatStack supports three authentication methods:

1. Browser-Based OAuth2 Authentication

ss.login()  # Opens your default browser for authentication

2. Direct API Key Authentication

client = ss.Client(api_key="your-api-key")

3. Environment Variable

Set the SWEATSTACK_API_KEY environment variable:

export SWEATSTACK_API_KEY="your-api-key"

SweatStack follows this priority order:

Browser-based OAuth2 (ss.login())
Direct API key via Client constructor
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:

import sweatstack as ss

activities = ss.list_activities()

Class-based interface:

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:

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()

Metadata

Release files for sweatstack 0.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sweatstack 0.20.0
File	Size	Uploaded
sweatstack-0.20.0.tar.gz	4.0 MB	Mar 3, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for sweatstack 0.20.0
File	Interpreter	ABI	Platform	Reset
sweatstack-0.20.0-py3-none-any.whl 2.0 MB Mar 3, 2025	Python 3	none	any	Details

Total release size: 5.9 MB

Release files / sweatstack-0.20.0.tar.gz

Download URL	sweatstack-0.20.0.tar.gz
Size	4.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`e314f5c14b637809d3e2d03ed747f74ebe1991ffd0653eee69414eef1c302625`
BLAKE2b-256 checksum How to use checksums	`a8a1463f42902973483f57083e891f8c9a6157c8b99a57568c464264ff696317`
Upload date	Mar 3, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.5`

Release files / sweatstack-0.20.0-py3-none-any.whl

Download URL	sweatstack-0.20.0-py3-none-any.whl
Size	2.0 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`3b6211cf4e8c5aef5cbf7baefd01d3ed7d52041100973156f0d748e11ff3ad86`
BLAKE2b-256 checksum How to use checksums	`9d24d789a1b6c13bcb3d05c4e15784ca86f0f28371b647e8329bf6e118ee644c`
Upload date	Mar 3, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.5`