otf-api 0.12.0__tar.gz → 0.13.0__tar.gz

{otf_api-0.12.0/src/otf_api.egg-info → otf_api-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otf-api
-Version: 0.12.0
+Version: 0.13.0
 Summary: Python OrangeTheory Fitness API Client
 Author-email: Jessica Smith <j.smith.git1@gmail.com>
 License-Expression: MIT
@@ -9,7 +9,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Operating System :: OS Independent
@@ -27,6 +26,9 @@ Requires-Dist: yarl<2,>=1.18.3
 Requires-Dist: tenacity<10,>=9.0.0
 Requires-Dist: cachetools>=5.5.0
 Requires-Dist: pendulum>=3.1.0
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: platformdirs>=4.3.6
+Requires-Dist: packaging>=24.2
 Dynamic: license-file
 
 Simple API client for interacting with the OrangeTheory Fitness APIs.

{otf_api-0.12.0 → otf_api-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "otf-api"
-version = "0.12.0"
+version = "0.13.0"
 description = "Python OrangeTheory Fitness API Client"
 authors = [{ name = "Jessica Smith", email = "j.smith.git1@gmail.com" }]
 requires-python = ">=3.11"
@@ -11,7 +11,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3.11",
     "Topic :: Software Development :: Libraries :: Python Modules",
-    "Topic :: Software Development :: Libraries :: Application Frameworks",
     "Topic :: Software Development :: Libraries",
     "Topic :: Internet :: WWW/HTTP",
     "Operating System :: OS Independent",
@@ -28,6 +27,9 @@ dependencies = [
     "tenacity>=9.0.0,<10",
     "cachetools>=5.5.0",
     "pendulum>=3.1.0",
+    "diskcache>=5.6.3",
+    "platformdirs>=4.3.6",
+    "packaging>=24.2",
 ]
 
 [project.urls]
@@ -47,23 +49,19 @@ dev = [
     "twine==5.1.1",
 ]
 docs = [
-    "griffe<1.0.0",
-    "griffe-fieldz==0.1.2",
-    "mike==2.1.1",
-    "mkdocs==1.6.0",
-    "mkdocs-autorefs==1.0.1",
-    "mkdocs-gen-files==0.5.0",
-    "mkdocs-get-deps==0.2.0",
-    "mkdocs-include-markdown-plugin==6.2.0",
-    "mkdocs-literate-nav==0.6.1",
-    "mkdocs-material==9.5.26",
-    "mkdocs-material-extensions==1.3.1",
-    "mkdocs-section-index==0.3.9",
-    "mkdocstrings==0.25.1",
-    "mkdocstrings-python==1.10.3",
-    "pkginfo<1.11",
-    "setuptools>=70.0.0,<71",
-    "virtualenv>=20.26.2,<21",
+    "autodoc-pydantic>=2.2.0",
+    "furo>=2024.8.6",
+    "sphinx==8.3.0",
+    "sphinx-autobuild==2024.10.3",
+    "sphinx-autodoc-typehints==3.2.0",
+    "sphinx-autodoc2==0.5.0",
+    "sphinx-basic-ng==1.0.0b2",
+    "sphinxcontrib-applehelp==2.0.0",
+    "sphinxcontrib-devhelp==2.0.0",
+    "sphinxcontrib-htmlhelp==2.1.0",
+    "sphinxcontrib-jsmath==1.0.1",
+    "sphinxcontrib-qthelp==2.0.0",
+    "sphinxcontrib-serializinghtml==2.0.0",
 ]
 
 [tool.uv]

otf_api-0.13.0/src/otf_api/__init__.py

@@ -0,0 +1,42 @@
+"""Unofficial Orangetheory API client.
+
+This software is not affiliated with, endorsed by, or supported by Orangetheory Fitness.
+Use it at your own risk. It may break at any time if Orangetheory changes their services.
+"""
+
+import logging
+import os
+
+from otf_api import models
+from otf_api.api import Otf
+from otf_api.auth import OtfUser
+
+LOG_LEVEL = os.getenv("OTF_LOG_LEVEL", "INFO").upper()
+LOG_LEVEL_NUM = getattr(logging, LOG_LEVEL, logging.INFO)
+LOG_FMT = "{asctime} - {module}.{funcName}:{lineno} - {levelname} - {message}"
+DATE_FMT = "%Y-%m-%d %H:%M:%S%z"
+
+
+def _setup_logging() -> None:
+    logger = logging.getLogger("otf_api")
+
+    if logger.handlers:
+        return  # Already set up
+
+    # 2) Set the logger level to INFO (or whatever you need).
+    logger.setLevel(LOG_LEVEL_NUM)
+
+    # 3) Create a handler (e.g., console) and set its formatter.
+    handler = logging.StreamHandler()
+    handler.setFormatter(logging.Formatter(fmt=LOG_FMT, datefmt=DATE_FMT, style="{"))
+
+    # 4) Add this handler to your package logger.
+    logger.addHandler(handler)
+
+
+_setup_logging()
+
+__version__ = "0.13.0"
+
+
+__all__ = ["Otf", "OtfUser", "models"]

otf_api-0.13.0/src/otf_api/api/__init__.py

@@ -0,0 +1,3 @@
+from otf_api.api.api import Otf
+
+__all__ = ["Otf"]

otf_api-0.13.0/src/otf_api/api/_compat.py

@@ -0,0 +1,77 @@
+# ruff: noqa
+
+
+import warnings
+
+
+_LEGACY_METHOD_MAP = {
+    "book_class": "bookings.book_class",
+    "book_class_new": "bookings.book_class_new",
+    "cancel_booking": "bookings.cancel_booking",
+    "cancel_booking_new": "bookings.cancel_booking_new",
+    "get_booking": "bookings.get_booking",
+    "get_booking_from_class": "bookings.get_booking_from_class",
+    "get_booking_from_class_new": "bookings.get_booking_from_class_new",
+    "get_booking_new": "bookings.get_booking_new",
+    "get_bookings": "bookings.get_bookings",
+    "get_bookings_new": "bookings.get_bookings_new",
+    "get_bookings_new_by_date": "bookings.get_bookings_new_by_date",
+    "get_classes": "bookings.get_classes",
+    "get_historical_bookings": "bookings.get_historical_bookings",
+    "rate_class": "bookings.rate_class",
+    "get_email_notification_settings": "members.get_email_notification_settings",
+    "get_member_detail": "members.get_member_detail",
+    "get_member_membership": "members.get_member_membership",
+    "get_member_purchases": "members.get_member_purchases",
+    "get_sms_notification_settings": "members.get_sms_notification_settings",
+    "update_email_notification_settings": "members.update_email_notification_settings",
+    "update_member_name": "members.update_member_name",
+    "update_sms_notification_settings": "members.update_sms_notification_settings",
+    "add_favorite_studio": "studios.add_favorite_studio",
+    "get_favorite_studios": "studios.get_favorite_studios",
+    "get_studio_detail": "studios.get_studio_detail",
+    "get_studio_services": "studios.get_studio_services",
+    "get_studios_by_geo": "studios.get_studios_by_geo",
+    "remove_favorite_studio": "studios.remove_favorite_studio",
+    "search_studios_by_geo": "studios.search_studios_by_geo",
+    "get_benchmarks": "workouts.get_benchmarks",
+    "get_benchmarks_by_challenge_category": "workouts.get_benchmarks_by_challenge_category",
+    "get_benchmarks_by_equipment": "workouts.get_benchmarks_by_equipment",
+    "get_body_composition_list": "workouts.get_body_composition_list",
+    "get_challenge_tracker": "workouts.get_challenge_tracker",
+    "get_challenge_tracker_detail": "workouts.get_challenge_tracker_detail",
+    "get_hr_history": "workouts.get_hr_history",
+    "get_member_lifetime_stats_in_studio": "workouts.get_member_lifetime_stats_in_studio",
+    "get_member_lifetime_stats_out_of_studio": "workouts.get_member_lifetime_stats_out_of_studio",
+    "get_out_of_studio_workout_history": "workouts.get_out_of_studio_workout_history",
+    "get_performance_summary": "workouts.get_performance_summary",
+    "get_telemetry": "workouts.get_telemetry",
+    "get_workout_from_booking": "workouts.get_workout_from_booking",
+    "get_workouts": "workouts.get_workouts",
+    "rate_class_from_workout": "workouts.rate_class_from_workout",
+}
+
+
+def _generate_legacy_method(old_name, new_path):
+    def method(self, *args, **kwargs):
+        warnings.warn(
+            f"`Otf.{old_name}()` is deprecated. Use `Otf.{new_path}()` instead.", DeprecationWarning, stacklevel=2
+        )
+
+        # Resolve nested attributes like 'bookings.cancel'
+        target = self
+        for attr in new_path.split("."):
+            target = getattr(target, attr)
+
+        return target(*args, **kwargs)
+
+    method.__name__ = old_name
+    return method
+
+
+class _LegacyCompatMixin:
+    pass
+
+
+for legacy_name, new_path in _LEGACY_METHOD_MAP.items():
+    setattr(_LegacyCompatMixin, legacy_name, _generate_legacy_method(legacy_name, new_path))

otf_api-0.13.0/src/otf_api/api/api.py

@@ -0,0 +1,80 @@
+from otf_api import models
+from otf_api.api._compat import _LegacyCompatMixin
+from otf_api.auth import OtfUser
+
+from .bookings import BookingApi
+from .client import OtfClient
+from .members import MemberApi
+from .studios import StudioApi
+from .workouts import WorkoutApi
+
+# TODO: clean up docs and turn on autodoc when we get rig of _LegacyCompatMixin
+
+
+class Otf(_LegacyCompatMixin):
+    """The main OTF API client.
+
+    This class handles serialization and enrichment of data from the OTF API. The actual requests to the OTF API are\
+    handled by separate client classes. This class provides methods to get bookings, classes, member details, and more.
+    It also provides methods to book and cancel classes, get member stats, and manage favorite studios.
+
+    It is designed to be used with an authenticated user, which can be provided as an `OtfUser` object. If no user is\
+    provided, the `OtfClient` class will attempt to use cached credentials, environment variables, or prompt the user\
+    for credentials.
+    """
+
+    bookings: BookingApi
+    members: MemberApi
+    workouts: WorkoutApi
+    studios: StudioApi
+
+    def __init__(self, user: OtfUser | None = None):
+        """Initialize the OTF API client.
+
+        Args:
+            user (OtfUser): The user to authenticate as.
+        """
+        client = OtfClient(user)
+
+        self.bookings = BookingApi(self, client)
+        self.members = MemberApi(self, client)
+        self.workouts = WorkoutApi(self, client)
+        self.studios = StudioApi(self, client)
+
+        self._member: models.MemberDetail | None = None
+
+    @property
+    def member_uuid(self) -> str:
+        """Get the member UUID."""
+        return self.member.member_uuid
+
+    @property
+    def member(self) -> models.MemberDetail:
+        """Get the member details.
+
+        This will lazily load the member details if they have not been loaded yet.
+        """
+        if self._member is None:
+            self._member = self.members.get_member_detail()
+        return self._member
+
+    @property
+    def home_studio(self) -> models.StudioDetail:
+        """Get the home studio details."""
+        return self.member.home_studio
+
+    @property
+    def home_studio_uuid(self) -> str:
+        """Get the home studio UUID."""
+        return self.home_studio.studio_uuid
+
+    def refresh_member(self) -> models.MemberDetail:
+        """Refresh the member details.
+
+        This will reload the member details from the OTF API.
+
+        Returns:
+            MemberDetail: The refreshed member details.
+        """
+        self._member = self.members.get_member_detail()
+        return self._member

otf_api-0.13.0/src/otf_api/api/bookings/__init__.py

@@ -0,0 +1,3 @@
+from .booking_api import BookingApi
+
+__all__ = ["BookingApi"]