sweatstack 0.53.0__tar.gz → 0.55.0__tar.gz

{sweatstack-0.53.0 → sweatstack-0.55.0}/.claude/settings.local.json

@@ -2,8 +2,9 @@
   "permissions": {
     "allow": [
       "Bash(python:*)",
-      "WebFetch(domain:app.sweatstack.no)"
+      "WebFetch(domain:app.sweatstack.no)",
+      "Bash(cat:*)"
     ],
     "deny": []
   }
-}
+}

{sweatstack-0.53.0 → sweatstack-0.55.0}/.gitignore

@@ -8,3 +8,6 @@ wheels/
 
 # Virtual environments
 .venv
+
+# Documentation
+docs/_build/

{sweatstack-0.53.0 → sweatstack-0.55.0}/CHANGELOG.md

@@ -6,6 +6,24 @@ 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.55.0] - 2025-10-24
+
+### Added
+- Added a new `get_activity_awd()` method to the `ss.Client` class that allows for getting the accumulated work duration (AWD) data for a specific activity.
+- Added a new `get_longitudinal_awd()` method to the `ss.Client` class that allows for getting the AWD data for a specific date range.
+
+
+## [0.54.0] - 2025-09-11
+
+### Added
+
+- Added new methods `get_authorization_url()`, `exchange_code_for_token()` and `get_pkce_params()` to the `ss.Client` class that allow for getting the authorization URL and exchanging a code for tokens. This should make it easier for clients to implement the SweatStack OAuth2 flow.
+
+### Fixed
+
+- Fixed an issue where the `ss.get_activities()` with `as_dataframe=True` method would raise an error if no activities were found.
+
+
 ## [0.53.0] - 2025-09-11
 
 ### Added

sweatstack-0.55.0/Makefile

@@ -0,0 +1,12 @@
+.PHONY: build publish docs
+
+
+build:
+	rm -rf dist
+	uvx --from build pyproject-build --installer uv
+
+publish: build
+	uvx twine upload dist/*
+
+docs:
+	uv run sphinx-build -b markdown docs docs/_build/markdown

{sweatstack-0.53.0 → sweatstack-0.55.0}/PKG-INFO

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

sweatstack-0.55.0/docs/conf.py

@@ -0,0 +1,26 @@
+import os
+import sys
+
+# So autodoc can import your package
+sys.path.insert(0, os.path.abspath(".."))  # adjust if needed
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",        # if you use Google/NumPy docstrings
+    "sphinx_markdown_builder",    # <-- this is the important one
+    "myst_parser",                # optional, for .md sources
+]
+
+autosummary_generate = True
+
+# Autodoc configuration
+autodoc_default_options = {
+    'private-members': False,  # Don't document private members (starting with _)
+    'special-members': False,  # Don't document special members (like __init__ unless specified)
+}
+
+# Optional nice-to-haves for markdown builder:
+markdown_anchor_sections = True   # add anchors to each section/function/class
+markdown_anchor_signatures = True # add anchors to signatures
+markdown_bullet = "*"

sweatstack-0.55.0/docs/everything.rst

@@ -0,0 +1,171 @@
+Complete API Reference
+======================
+
+Environment Variables
+=====================
+
+The SweatStack client library uses environment variables for configuration.
+These variables provide defaults for authentication, caching, and Streamlit integration.
+
+Authentication
+--------------
+
+.. envvar:: SWEATSTACK_API_KEY
+
+   API access token for authenticating with SweatStack.
+
+   Automatically loaded by the Client if not provided during initialization.
+   Falls back to persistent storage if not found in environment.
+
+   Example::
+
+      export SWEATSTACK_API_KEY="your_token_here"
+
+.. envvar:: SWEATSTACK_REFRESH_TOKEN
+
+   Refresh token used for automatic token renewal.
+
+   Loaded from environment, instance, or persistent storage. Used by the Client
+   to automatically refresh expired access tokens.
+
+.. envvar:: SWEATSTACK_URL
+
+   Custom SweatStack instance URL.
+
+   Override the default SweatStack API URL. Useful for testing or
+   connecting to self-hosted instances.
+
+   Default: ``https://app.sweatstack.no``
+
+Caching
+-------
+
+.. envvar:: SWEATSTACK_LOCAL_CACHE
+
+   Enable local filesystem caching of API responses.
+
+   Set to any truthy value (``1``, ``true``, ``yes``) to enable caching
+   of longitudinal data requests. Cached data persists across sessions.
+   Use ``client.clear_cache()`` to remove cached data.
+
+   Default: Disabled
+
+   Example::
+
+      export SWEATSTACK_LOCAL_CACHE=1
+
+.. envvar:: SWEATSTACK_CACHE_DIR
+
+   Custom directory location for cached data.
+
+   Specify where to store cached API responses. If not set, defaults to
+   the system temp directory with a ``sweatstack/{user_id}`` subdirectory.
+
+   Default: System temp directory (e.g., ``/tmp/sweatstack/{user_id}``)
+
+   Example::
+
+      export SWEATSTACK_CACHE_DIR=/path/to/cache
+
+Streamlit OAuth2
+----------------
+
+These environment variables are used by :class:`sweatstack.streamlit.StreamlitAuth`
+for OAuth2 authentication in Streamlit applications.
+
+.. envvar:: SWEATSTACK_CLIENT_ID
+
+   OAuth2 application client ID.
+
+   The client ID from your registered SweatStack OAuth2 application.
+   Required for Streamlit authentication if not provided to StreamlitAuth.
+
+.. envvar:: SWEATSTACK_CLIENT_SECRET
+
+   OAuth2 application client secret.
+
+   The client secret from your registered SweatStack OAuth2 application.
+   Required for Streamlit authentication if not provided to StreamlitAuth.
+
+.. envvar:: SWEATSTACK_SCOPES
+
+   Comma-separated list of OAuth2 scopes.
+
+   Specify which permissions to request during OAuth2 authorization.
+
+   Default: ``data:read,profile``
+
+   Example::
+
+      export SWEATSTACK_SCOPES="data:read,data:write,profile"
+
+.. envvar:: SWEATSTACK_REDIRECT_URI
+
+   OAuth2 redirect URI.
+
+   The URI where users are redirected after OAuth2 authorization.
+   Must match a redirect URI registered in your OAuth2 application.
+
+   Example::
+
+      export SWEATSTACK_REDIRECT_URI="http://localhost:8501"
+
+Modules
+=======
+
+sweatstack
+----------
+
+.. automodule:: sweatstack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sweatstack.client
+-----------------
+
+.. automodule:: sweatstack.client
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :exclude-members: _LocalCacheMixin, _TokenStorageMixin, _OAuth2Mixin, _DelegationMixin
+
+
+sweatstack.streamlit
+--------------------
+
+.. automodule:: sweatstack.streamlit
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sweatstack.schemas
+------------------
+
+.. automodule:: sweatstack.schemas
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Sport
+~~~~~
+
+.. autoclass:: sweatstack.schemas.Sport
+    :members: root_sport, parent_sport, is_sub_sport_of, is_root_sport, display_name
+    :undoc-members:
+
+Metric
+~~~~~~
+
+.. autoclass:: sweatstack.schemas.Metric
+    :members: display_name
+    :undoc-members:
+
+sweatstack.openapi_schemas
+------------------
+
+.. automodule:: sweatstack.openapi_schemas
+    :members:
+    :undoc-members:
+    :show-inheritance:

{sweatstack-0.53.0 → sweatstack-0.55.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sweatstack"
-version = "0.53.0"
+version = "0.55.0"
 description = "The official Python client for SweatStack"
 readme = "README.md"
 authors = [
@@ -33,6 +33,10 @@ build-backend = "hatchling.build"
 [dependency-groups]
 dev = [
     "datamodel-code-generator>=0.26.5",
+    "myst-parser>=4.0.1",
+    "sphinx>=8.2.3",
+    "sphinx-markdown-builder>=0.6.8",
+    "streamlit>=1.42.0",
 ]
 
 [tool.uv.workspace]