otf-api 0.4.0__tar.gz → 0.6.0__tar.gz

{otf_api-0.4.0 → otf_api-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otf-api
-Version: 0.4.0
+Version: 0.6.0
 Summary: Python OrangeTheory Fitness API Client
 License: MIT
 Author: Jessica Smith
@@ -18,7 +18,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: aiohttp (==3.9.5)
+Requires-Dist: aiohttp (==3.8.*)
 Requires-Dist: humanize (>=4.9.0,<5.0.0)
 Requires-Dist: inflection (==0.5.*)
 Requires-Dist: loguru (==0.7.2)
@@ -27,15 +27,13 @@ Requires-Dist: pint (==0.24.*)
 Requires-Dist: pycognito (==2024.5.1)
 Requires-Dist: pydantic (==2.7.3)
 Requires-Dist: python-box (>=7.2.0,<8.0.0)
-Requires-Dist: readchar (>=4.1.0,<5.0.0)
-Requires-Dist: typer (>=0.12.3,<0.13.0)
 Project-URL: Documentation, https://otf-api.readthedocs.io/en/stable/
 Description-Content-Type: text/markdown
 
 Simple API client for interacting with the OrangeTheory Fitness APIs.
 
 
-This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings. It is a work in progress, currently only allowing access to GET calls, but my goal is to expand it to include POST, PUT, and DELETE calls as well.
+This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings.
 
 ## Installation
 ```bash

{otf_api-0.4.0 → otf_api-0.6.0}/README.md

@@ -1,7 +1,7 @@
 Simple API client for interacting with the OrangeTheory Fitness APIs.
 
 
-This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings. It is a work in progress, currently only allowing access to GET calls, but my goal is to expand it to include POST, PUT, and DELETE calls as well.
+This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings.
 
 ## Installation
 ```bash

{otf_api-0.4.0 → otf_api-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "otf-api"
-version = "0.4.0"
+version = "0.6.0"
 description = "Python OrangeTheory Fitness API Client"
 authors = ["Jessica Smith <j.smith.git1@gmail.com>"]
 license = "MIT"
@@ -22,7 +22,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.10"
-aiohttp = "3.9.5"
+aiohttp = "3.8.*"
 humanize = "^4.9.0"
 inflection = "0.5.*"
 loguru = "0.7.2"
@@ -31,8 +31,6 @@ pint = "0.24.*"
 pycognito = "2024.5.1"
 pydantic = "2.7.3"
 python-box = "^7.2.0"
-readchar = "^4.1.0"
-typer = "^0.12.3"
 
 [tool.poetry.group.dev.dependencies]
 aioresponses = "0.7.6"
@@ -70,14 +68,9 @@ setuptools = "^70.0.0"
 virtualenv = "^20.26.2"
 
 
-[tool.poetry.group.cli.dependencies]
-
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
-
-[tool.poetry.scripts]
-otf = "otf_api.cli:base_app"

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/__init__.py

@@ -6,7 +6,7 @@ from loguru import logger
 from .api import Otf
 from .auth import OtfUser
 
-__version__ = "0.4.0"
+__version__ = "0.6.0"
 
 
 __all__ = ["Otf", "OtfUser"]

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/api.py

@@ -3,7 +3,6 @@ import contextlib
 import json
 import typing
 from datetime import date, datetime
-from math import ceil
 from typing import Any
 
 import aiohttp
@@ -43,7 +42,6 @@ from otf_api.models import (
     TelemetryHrHistory,
     TelemetryMaxHr,
     TotalClasses,
-    WorkoutList,
 )
 
 
@@ -226,32 +224,15 @@ class Otf:
         """Perform an API request to the performance summary API."""
         return await self._do(method, API_IO_BASE_URL, url, params, headers)
 
-    async def get_workouts(self) -> WorkoutList:
-        """Get the list of workouts from OT Live.
+    async def get_body_composition_list(self) -> BodyCompositionList:
+        """Get the member's body composition list.
 
         Returns:
-            WorkoutList: The list of workouts.
-
-        Info:
-            ---
-            This returns data from the same api the [OT Live website](https://otlive.orangetheory.com/) uses.
-            It is quite a bit of data, and all workouts going back to ~2019. The data includes the class history
-            UUID, which can be used to get telemetry data for a specific workout.
+            Any: The member's body composition list.
         """
+        data = await self._default_request("GET", f"/member/members/{self._member_uuid}/body-composition")
 
-        res = await self._default_request("GET", "/virtual-class/in-studio-workouts")
-
-        return WorkoutList(workouts=res["data"])
-
-    async def get_total_classes(self) -> TotalClasses:
-        """Get the member's total classes. This is a simple object reflecting the total number of classes attended,
-        both in-studio and OT Live.
-
-        Returns:
-            TotalClasses: The member's total classes.
-        """
-        data = await self._default_request("GET", "/mobile/v1/members/classes/summary")
-        return TotalClasses(**data["data"])
+        return BodyCompositionList(data=data["data"])
 
     async def get_classes(
         self,
@@ -346,6 +327,16 @@ class Otf:
 
         return classes_list
 
+    async def get_total_classes(self) -> TotalClasses:
+        """Get the member's total classes. This is a simple object reflecting the total number of classes attended,
+        both in-studio and OT Live.
+
+        Returns:
+            TotalClasses: The member's total classes.
+        """
+        data = await self._default_request("GET", "/mobile/v1/members/classes/summary")
+        return TotalClasses(**data["data"])
+
     async def book_class(self, class_uuid: str) -> BookClass | typing.Any:
         """Book a class by class_uuid.
 
@@ -860,16 +851,15 @@ class Otf:
         res = await self._telemetry_request("GET", path, params=params)
         return TelemetryMaxHr(**res)
 
-    async def get_telemetry(self, class_history_uuid: str, max_data_points: int = 0) -> Telemetry:
-        """Get the telemetry for a class history.
+    async def get_telemetry(self, performance_summary_id: str, max_data_points: int = 120) -> Telemetry:
+        """Get the telemetry for a performance summary.
 
         This returns an object that contains the max heartrate, start/end bpm for each zone,
         and a list of telemetry items that contain the heartrate, splat points, calories, and timestamp.
 
         Args:
-            class_history_uuid (str): The class history UUID.
-            max_data_points (int): The max data points to use for the telemetry. Default is 0, which will attempt to\
-            get the max data points from the workout. If the workout is not found, it will default to 120 data points.
+            performance_summary_id (str): The performance summary id.
+            max_data_points (int): The max data points to use for the telemetry. Default is 120.
 
         Returns:
             TelemetryItem: The telemetry for the class history.
@@ -877,30 +867,10 @@ class Otf:
         """
         path = "/v1/performance/summary"
 
-        max_data_points = max_data_points or await self._get_max_data_points(class_history_uuid)
-
-        params = {"classHistoryUuid": class_history_uuid, "maxDataPoints": max_data_points}
+        params = {"classHistoryUuid": performance_summary_id, "maxDataPoints": max_data_points}
         res = await self._telemetry_request("GET", path, params=params)
         return Telemetry(**res)
 
-    async def _get_max_data_points(self, class_history_uuid: str) -> int:
-        """Get the max data points to use for the telemetry.
-
-        Attempts to get the amount of active time for the workout from the OT Live API. If the workout is not found,
-        it will default to 120 data points. If it is found, it will calculate the amount of data points needed based on
-        the active time. This should amount to a data point per 30 seconds, roughly.
-
-        Args:
-            class_history_uuid (str): The class history UUID.
-
-        Returns:
-            int: The max data points to use.
-        """
-        workouts = await self.get_workouts()
-        workout = workouts.by_class_history_uuid.get(class_history_uuid)
-        max_data_points = 120 if workout is None else ceil(active_time_to_data_points(workout.active_time))
-        return max_data_points
-
     # the below do not return any data for me, so I can't test them
 
     async def _get_member_services(self, active_only: bool = True) -> typing.Any:
@@ -934,17 +904,3 @@ class Otf:
 
         data = self._default_request("GET", f"/member/wearables/{self._member_id}/wearable-daily", params=params)
         return data
-
-    async def get_body_composition_list(self) -> BodyCompositionList:
-        """Get the member's body composition list.
-
-        Returns:
-            Any: The member's body composition list.
-        """
-        data = await self._default_request("GET", f"/member/members/{self._member_uuid}/body-composition")
-
-        return BodyCompositionList(data=data["data"])
-
-
-def active_time_to_data_points(active_time: int) -> float:
-    return active_time / 60 * 2

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/auth.py

@@ -63,7 +63,8 @@ class OtfCognito(Cognito):
     @device_key.setter
     def device_key(self, value: str | None):
         if not value:
-            logger.info("Clearing device key")
+            if self._device_key:
+                logger.info("Clearing device key")
             self._device_key = value
             return
 

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/__init__.py

@@ -30,7 +30,6 @@ from .responses import (
     TelemetryHrHistory,
     TelemetryMaxHr,
     TotalClasses,
-    WorkoutList,
 )
 
 __all__ = [
@@ -66,5 +65,4 @@ __all__ = [
     "TelemetryHrHistory",
     "TelemetryMaxHr",
     "TotalClasses",
-    "WorkoutList",
 ]

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/base.py

@@ -1,14 +1,9 @@
 import inspect
 import typing
-from enum import Enum
-from typing import Any, ClassVar, TypeVar
+from typing import ClassVar, TypeVar
 
 from box import Box
-from inflection import humanize
 from pydantic import BaseModel, ConfigDict
-from rich.style import Style
-from rich.styled import Styled
-from rich.table import Table
 
 if typing.TYPE_CHECKING:
     from pydantic.main import IncEx
@@ -138,50 +133,6 @@ class BetterDumperMixin:
 class OtfItemBase(BetterDumperMixin, BaseModel):
     model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
-    def convert_row_value_types(self, row: list[Any]) -> list[str]:
-        for i, val in enumerate(row):
-            if isinstance(val, bool):
-                row[i] = str(val)
-                continue
-
-            if isinstance(val, Enum):
-                row[i] = val.name
-                continue
-
-            if val is None:
-                row[i] = ""
-                continue
-
-            row[i] = str(val)
-
-        return row
-
-    def get_style(self, is_selected: bool = False) -> Style:
-        return Style(color="blue", bold=True) if is_selected else Style(color="white")
-
-    def to_row(self, attributes: list[str], is_selected: bool = False) -> list[Styled]:
-        style = self.get_style(is_selected)
-
-        boxed_self = Box(self.model_dump(), box_dots=True)
-        row = [boxed_self.get(attr, "") for attr in attributes]
-        row = self.convert_row_value_types(row)
-        styled = [Styled(cell, style=style) for cell in row]
-
-        prefix = "> " if is_selected else "  "
-        styled.insert(0, Styled(prefix, style=style))
-
-        return styled
-
-    @property
-    def sidebar_data(self) -> Table | None:
-        return None
-
-    @classmethod
-    def attr_to_column_header(cls, attr: str) -> str:
-        attr_map = {k: humanize(k) for k in cls.model_fields}
-
-        return attr_map.get(attr, attr)
-
 
 class OtfListBase(BaseModel):
     model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
@@ -191,18 +142,6 @@ class OtfListBase(BaseModel):
     def collection(self) -> list[OtfItemBase]:
         return getattr(self, self.collection_field)
 
-    def to_table(self, columns: list[str]) -> Table:
-        table = Table(expand=True, show_header=True, show_footer=False)
-
-        table.add_column()
-        for column in columns:
-            table.add_column(OtfItemBase.attr_to_column_header(column))
-
-        for item in self.collection:
-            table.add_row(*item.to_row(columns))
-
-        return table
-
     def to_json(self, **kwargs) -> str:
         kwargs.setdefault("indent", 4)
         kwargs.setdefault("exclude_none", True)

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/responses/__init__.py

@@ -21,7 +21,6 @@ from .telemetry import Telemetry
 from .telemetry_hr_history import TelemetryHrHistory
 from .telemetry_max_hr import TelemetryMaxHr
 from .total_classes import TotalClasses
-from .workouts import WorkoutList
 
 __all__ = [
     "BodyCompositionList",
@@ -56,5 +55,4 @@ __all__ = [
     "TelemetryHrHistory",
     "TelemetryMaxHr",
     "TotalClasses",
-    "WorkoutList",
 ]

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/responses/bookings.py

@@ -4,9 +4,6 @@ from typing import ClassVar
 
 from inflection import humanize
 from pydantic import Field
-from rich.style import Style
-from rich.styled import Styled
-from rich.table import Table
 
 from otf_api.models.base import OtfItemBase, OtfListBase
 from otf_api.models.responses.classes import OtfClassTimeMixin
@@ -223,82 +220,7 @@ class Booking(OtfItemBase):
     def id_val(self) -> str:
         return self.class_booking_id
 
-    @property
-    def sidebar_data(self) -> Table:
-        data = {
-            "date": self.otf_class.date,
-            "class_name": self.otf_class.name,
-            "description": self.otf_class.description,
-            "class_id": self.id_val,
-            "studio_address": self.otf_class.studio.studio_location.physical_address,
-            "coach_name": self.otf_class.coach.name,
-        }
-
-        table = Table(expand=True, show_header=False, show_footer=False)
-        table.add_column("Key", style="cyan", ratio=1)
-        table.add_column("Value", style="magenta", ratio=2)
-
-        for key, value in data.items():
-            if value is False:
-                table.add_row(key, Styled(str(value), style="red"))
-            else:
-                table.add_row(key, str(value))
-
-        return table
-
-    def get_style(self, is_selected: bool = False) -> Style:
-        style = super().get_style(is_selected)
-        if self.status == BookingStatus.Cancelled:
-            style = Style(color="red")
-        elif self.status == BookingStatus.Waitlisted:
-            style = Style(color="yellow")
-        elif self.status == BookingStatus.CheckedIn and is_selected:
-            style = Style(color="blue", strike=True)
-        elif self.status == BookingStatus.CheckedIn:
-            style = Style(color="grey58")
-
-        return style
-
-    @classmethod
-    def attr_to_column_header(cls, attr: str) -> str:
-        if attr.startswith("otf_class"):
-            return OtfClass.attr_to_column_header(attr.split(".")[-1])
-
-        attr_map = {k: humanize(k) for k in cls.model_fields}
-        overrides = {
-            "day_of_week": "Class DoW",
-            "date": "Class Date",
-            "time": "Class Time",
-            "duration": "Class Duration",
-            "name": "Class Name",
-            "is_home_studio": "Home Studio",
-            "is_booked": "Booked",
-        }
-
-        attr_map.update(overrides)
-
-        return attr_map.get(attr, attr)
-
 
 class BookingList(OtfListBase):
     collection_field: ClassVar[str] = "bookings"
     bookings: list[Booking]
-
-    @staticmethod
-    def show_bookings_columns() -> list[str]:
-        return [
-            "otf_class.day_of_week",
-            "otf_class.date",
-            "otf_class.time",
-            "otf_class.duration",
-            "otf_class.name",
-            "status",
-            "otf_class.studio.studio_name",
-            "is_home_studio",
-        ]
-
-    def to_table(self, columns: list[str] | None = None) -> Table:
-        if not columns:
-            columns = self.show_bookings_columns()
-
-        return super().to_table(columns)

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/responses/classes.py

@@ -3,11 +3,7 @@ from enum import Enum
 from typing import ClassVar
 
 from humanize import precisedelta
-from inflection import humanize
 from pydantic import Field
-from rich.style import Style
-from rich.styled import Styled
-from rich.table import Table
 
 from otf_api.models.base import OtfItemBase, OtfListBase
 
@@ -176,80 +172,7 @@ class OtfClass(OtfItemBase, OtfClassTimeMixin):
         dow = self.starts_at_local.strftime("%A")
         return DoW.get_case_insensitive(dow)
 
-    @property
-    def sidebar_data(self) -> Table:
-        data = {
-            "class_date": self.date,
-            "class_time": self.time.strip(),
-            "class_name": self.name,
-            "class_id": self.id_val,
-            "available": self.has_availability,
-            "waitlist_available": self.waitlist_available,
-            "studio_address": self.studio.address.line1,
-            "coach_name": self.coach.first_name,
-            "waitlist_size": self.waitlist_size,
-            "max_capacity": self.max_capacity,
-        }
-
-        if not self.full:
-            del data["waitlist_available"]
-            del data["waitlist_size"]
-
-        table = Table(expand=True, show_header=False, show_footer=False)
-        table.add_column("Key", style="cyan", ratio=1)
-        table.add_column("Value", style="magenta", ratio=2)
-
-        for key, value in data.items():
-            if value is False:
-                table.add_row(key, Styled(str(value), style="red"))
-            else:
-                table.add_row(key, str(value))
-
-        return table
-
-    def get_style(self, is_selected: bool = False) -> Style:
-        style = super().get_style(is_selected)
-        if self.is_booked:
-            style = Style(color="grey58")
-        return style
-
-    @classmethod
-    def attr_to_column_header(cls, attr: str) -> str:
-        attr_map = {k: humanize(k) for k in cls.model_fields}
-        overrides = {
-            "day_of_week": "Class DoW",
-            "date": "Class Date",
-            "time": "Class Time",
-            "duration": "Class Duration",
-            "name": "Class Name",
-            "is_home_studio": "Home Studio",
-            "is_booked": "Booked",
-        }
-
-        attr_map.update(overrides)
-
-        return attr_map.get(attr, attr)
-
 
 class OtfClassList(OtfListBase):
     collection_field: ClassVar[str] = "classes"
     classes: list[OtfClass]
-
-    @staticmethod
-    def book_class_columns() -> list[str]:
-        return [
-            "day_of_week",
-            "date",
-            "time",
-            "duration",
-            "name",
-            "studio.name",
-            "is_home_studio",
-            "is_booked",
-        ]
-
-    def to_table(self, columns: list[str] | None = None) -> Table:
-        if not columns:
-            columns = self.book_class_columns()
-
-        return super().to_table(columns)

{otf_api-0.4.0 → otf_api-0.6.0}/src/otf_api/models/responses/performance_summary_list.py

@@ -33,7 +33,7 @@ class Studio(OtfItemBase):
 class Class(OtfItemBase):
     ot_base_class_uuid: str | None = None
     starts_at_local: str
-    name: str
+    name: str | None = None
     coach: Coach
     studio: Studio
 
@@ -56,7 +56,7 @@ class Ratings(OtfItemBase):
 
 
 class PerformanceSummaryEntry(OtfItemBase):
-    performance_summary_id: str = Field(..., alias="id")
+    id: str = Field(..., alias="id")
     details: Details
     ratable: bool
     otf_class: Class = Field(..., alias="class")

otf_api-0.4.0/src/otf_api/cli/__init__.py

@@ -1,4 +0,0 @@
-from otf_api.cli.app import base_app
-from otf_api.cli.bookings import bookings_app, classes_app
-
-__all__ = ["base_app", "bookings_app", "classes_app"]

otf_api-0.4.0/src/otf_api/cli/_utilities.py

@@ -1,60 +0,0 @@
-import functools
-import inspect
-import traceback
-from collections.abc import Awaitable, Callable
-from typing import Any, NoReturn, ParamSpec, TypeGuard, TypeVar
-
-import typer
-from click.exceptions import ClickException
-
-T = TypeVar("T")
-P = ParamSpec("P")
-R = TypeVar("R")
-
-
-def is_async_fn(func: Callable[P, R] | Callable[P, Awaitable[R]]) -> TypeGuard[Callable[P, Awaitable[R]]]:
-    """
-    Returns `True` if a function returns a coroutine.
-
-    See https://github.com/microsoft/pyright/issues/2142 for an example use
-    """
-    while hasattr(func, "__wrapped__"):
-        func = func.__wrapped__
-
-    return inspect.iscoroutinefunction(func)
-
-
-def exit_with_error(message: Any, code: int = 1, **kwargs: Any) -> NoReturn:
-    """
-    Utility to print a stylized error message and exit with a non-zero code
-    """
-    from otf_api.cli.app import base_app
-
-    kwargs.setdefault("style", "red")
-    base_app.console.print(message, **kwargs)
-    raise typer.Exit(code)
-
-
-def exit_with_success(message: Any, **kwargs: Any) -> NoReturn:
-    """
-    Utility to print a stylized success message and exit with a zero code
-    """
-    from otf_api.cli.app import base_app
-
-    kwargs.setdefault("style", "green")
-    base_app.console.print(message, **kwargs)
-    raise typer.Exit(0)
-
-
-def with_cli_exception_handling(fn: Callable[[Any], Any]) -> Callable[[Any], Any]:
-    @functools.wraps(fn)
-    def wrapper(*args: Any, **kwargs: Any) -> Any | None:
-        try:
-            return fn(*args, **kwargs)
-        except (typer.Exit, typer.Abort, ClickException):
-            raise  # Do not capture click or typer exceptions
-        except Exception:
-            traceback.print_exc()
-            exit_with_error("An exception occurred.")
-
-    return wrapper