StreamlitAuth class

__init__(client_id=None, client_secret=None, scope=None, redirect_uri=None)

Parameters:

Name	Type	Description	Default
client_id		The client ID to use. If not provided, the SWEATSTACK_CLIENT_ID environment variable will be used.	None
client_secret		The client secret to use. If not provided, the SWEATSTACK_CLIENT_SECRET environment variable will be used.	None
scope		The scope to use. If not provided, the SWEATSTACK_SCOPE environment variable will be used.	None
redirect_uri		The redirect URI to use. If not provided, the SWEATSTACK_REDIRECT_URI environment variable will be used.	None

authenticate()

Authenticates the user with SweatStack.

This method handles the authentication flow for SweatStack in a Streamlit app. It checks if the user is already authenticated, and if not, displays a login button. If the user is authenticated, it displays a logout button.

When the user clicks the login button, they are redirected to the SweatStack authorization page. After successful authorization, they are redirected back to the Streamlit app with an authorization code, which is exchanged for an access token.

Returns:

Type	Description
	None

is_authenticated()

Checks if the user is currently authenticated with SweatStack.

This method determines if the user has a valid API key stored in the session state or in the instance. It does not verify if the API key is still valid with the server.

Returns:

Name	Type	Description
bool		True if the user has an API key, False otherwise.

select_activity(*, start=None, end=None, sports=None, tags=None, limit=100)

Select an activity from the user's activities.

This method retrieves activities based on specified filters and displays them in a dropdown for selection.

Parameters:

Name	Type	Description	Default
start	date | None	Optional start date to filter activities.	None
end	date | None	Optional end date to filter activities.	None
sports	list[Sport] | None	Optional list of sports to filter activities by.	None
tags	list[str] | None	Optional list of tags to filter activities by.	None
limit	int | None	Maximum number of activities to retrieve. Defaults to 100.	100

Returns:

Type	Description
	The selected activity object.

Note

Activities are displayed in the format "YYYY-MM-DD sport_name".

select_metric(allow_multiple=False)

Select a metric from the available metrics.

This method displays metrics in a dropdown or multiselect for selection.

Parameters:

Name	Type	Description	Default
allow_multiple	bool	If True, allows selecting multiple metrics. Defaults to False.	False

Returns:

Type	Description
	Metric or list[Metric]: The selected metric or list of metrics, depending on allow_multiple.

select_sport(only_root=False, allow_multiple=False, only_available=True)

Select a sport from the available sports.

This method retrieves sports and displays them in a dropdown or multiselect for selection.

Parameters:

Name	Type	Description	Default
only_root	bool	If True, only returns root sports without parents. Defaults to False.	False
allow_multiple	bool	If True, allows selecting multiple sports. Defaults to False.	False
only_available	bool	If True, only shows sports available to the user. If False, shows all sports defined in the Sport enum. Defaults to True.	True

Returns:

Type	Description
	Sport or list[Sport]: The selected sport or list of sports, depending on allow_multiple.

Note

Sports are displayed in a human-readable format using the format_sport function.

select_tag(allow_multiple=False)

Select a tag from the available tags.

This method retrieves tags and displays them in a dropdown or multiselect for selection.

Parameters:

Name	Type	Description	Default
allow_multiple	bool	If True, allows selecting multiple tags. Defaults to False.	False

Returns:

Type	Description
	str or list[str]: The selected tag or list of tags, depending on allow_multiple.

Note

Empty tags are displayed as "-" in the dropdown.

select_user()

Displays a user selection dropdown and switches the client to the selected user.

This method retrieves a list of users accessible to the current user and displays them in a dropdown. When a user is selected, the client is switched to operate on behalf of that user. The method first switches back to the principal user to ensure the full list of available users is displayed.

Returns:

Name	Type	Description
UserSummary		The selected user object.

Note

This method requires the user to have appropriate permissions to access other users. For regular users, this typically only shows their own user information.

switch_to_principal_user()

Switches the client back to the principal user.

This method reverts the client's authentication from a delegated user back to the principal user. The client will use the principal token for all subsequent API calls and updates the session state with the new API key.

Returns:

Type	Description
	None

Raises:

Type	Description
HTTPStatusError	If the principal token request fails.