SweatStack Python Library

Overview

This is the Python library for Sweat Stack, a powerfull application designed for athletes, coaches, and sports scientists to analyze athletic performance data. This library provides a seamless interface to interact with the SweatStack API, allowing users to retrieve, analyze, and visualize activity data and performance metrics.

Installation

We recommend using uv to manage Python and install the library. Read more about uv here.

uv pip install sweatstack

You can also install it with pip (or pipx) directly.

python -m pip install sweatstack

Quickstart

If you have uv installed, the fastest way to get started is to run the following command in your terminal:

uvx --from "sweatstack[jupyterlab]" sweatlab

This will open a JupyterLab instance with the SweatStack library pre-imported and authenticated via the browser authentication flow.

uvx --from "sweatstack[ipython]" sweatshell

This will open an interactive Python shell with the SweatStack library pre-imported and it will automatically trigger the browser authentication flow.

Alternatively, you can open a Python shell of your own choice, install the library and get started:

import sweatstack as ss

ss.login()

latest_activity = ss.get_latest_activity()

print(latest_activity)  # `latest_activity` is a pandas DataFrame

Authentication

To be able to access your data in Sweat Stack, you need to authenticate the library with your Sweat Stack account. The easiest way to do this is to use your browser to login:

import sweatstack as ss

ss.login()

This will automaticallyset the appropriate authentication tokens in your Python code.

Alternatively, you can set the SWEAT_STACK_API_KEY environment variable to your API key. You can create an API key here.

import os

import sweatstack as ss

os.environ["SWEAT_STACK_API_KEY"] = "your_api_key_here"

# Now you can use the library

Listing activities

To list activities, you can use the list_activities() function:

for activity in ss.list_activities():
    print(activity)

Info: This method returns a summary of the activities, not the actual timeseries data. To get the actual data, you need to use the get_activity_data() or get_latest_activity_data()) methods documented below.

Getting activity summaries

To get the summary of an activity, you can use the get_activity() function:

activity = ss.get_activity(activity_id)
print(activity)

To quickly the latest activity, you can use the get_latest_activity() function:

activity = ss.get_latest_activity()
print(activity)

Getting activity data

To get the timeseries data of one activity, you can use the get_activity_data() method:

data = ss.get_activity_data(activity_id)
print(data)

This method returns a pandas DataFrame. If your are not familiar with pandas and/or DataFrames, start by reading this introduction.

Similar as for the summaries, you can use the get_latest_activity_data() method to get the timeseries data of the latest activity:

data = ss.get_latest_activity_data()
print(data)

To get the timeseries data of multiple activities, you can use the get_longitudinal_data() method:

longitudinal_data = ss.get_longitudinal_data(
    start=date.today() - timedelta(days=180),
    sport="running",
    metrics=["power", "heart_rate"],
)
print(longitudinal_data)

Because the result of get_longitudinal_data() can be very large, the data is retrieved in a compressed format (parquet) that requires the pyarrow library to be installed. If you intend to use this method, make sure to install the sweatstack library with this extra dependency:

uv pip install sweatstack[parquet]

Also note that depending on the amount of data that you requested, this might take a while.

Accessing other user's data

By default, the library will give you access to your own data.

You can list all users you have access to with the list_accessible_users() method:

for user in ss.list_accessible_users():
    print(user)

You can switch to another user by using the switch_user() method:

ss.switch_user(user)

Calling any of the methods above will return the data for the user you switched to.

You can easily switch back to your original user by calling the switch_to_root_user() method:

ss.switch_to_root_user()

Metrics

The API supports the following metrics:

power: Power in Watt
speed: Speed in m/s
heart_rate: Heart rate in BPM
smo2: Muscle oxygen saturation in %
core_temperature: Core body temperature in °C
altitude: Altitude in meters
cadence: Cadence in RPM
temperature: Ambient temperature in °C
distance: Distance in m
longitude: Longitude in degrees
latitude: Latitude in degrees

Sports

The API supports the following sports:

running: Running
cycling: Cycling

More sports will be added in the future.

Metadata

Release files for sweatstack 0.2.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.2.0
File	Size	Uploaded
sweatstack-0.2.0.tar.gz	9.4 kB	Aug 30, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for sweatstack 0.2.0
File	Interpreter	ABI	Platform	Reset
sweatstack-0.2.0-py3-none-any.whl 10.3 kB Aug 30, 2024	Python 3	none	any	Details

Total release size: 19.7 kB

Release files / sweatstack-0.2.0.tar.gz

Download URL	sweatstack-0.2.0.tar.gz
Size	9.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`fc70475457578c77778f6c31ef14c20b227aea56f417e9d1579cac8f7051f05c`
BLAKE2b-256 checksum How to use checksums	`92d9a2f5ef50dbfae726e0effdb137a612a0e01eaec759b4d8d87a83bf612421`
Upload date	Aug 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.5`

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

Download URL	sweatstack-0.2.0-py3-none-any.whl
Size	10.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4010dd59e453eb1f6d142a3f75254ef457cc006bf2d4b0d57aab91fd5d1fdb88`
BLAKE2b-256 checksum How to use checksums	`148c06a0c85b89f0692517f511f810b35a93a3d7630595814e2b2d583eb10caa`
Upload date	Aug 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.5`