otf-api 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

otf_api/models/responses/performance_summary_list.py

@@ -1,9 +1,9 @@
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class ZoneTimeMinutes(OtfBaseModel):
+class ZoneTimeMinutes(OtfItemBase):
     gray: int
     blue: int
     green: int
@@ -11,7 +11,7 @@ class ZoneTimeMinutes(OtfBaseModel):
     red: int
 
 
-class Details(OtfBaseModel):
+class Details(OtfItemBase):
     calories_burned: int
     splat_points: int
     step_count: int
@@ -19,18 +19,18 @@ class Details(OtfBaseModel):
     zone_time_minutes: ZoneTimeMinutes
 
 
-class Coach(OtfBaseModel):
+class Coach(OtfItemBase):
     image_url: str | None = None
     first_name: str
 
 
-class Studio(OtfBaseModel):
+class Studio(OtfItemBase):
     id: str
     license_number: str
     name: str
 
 
-class Class(OtfBaseModel):
+class Class(OtfItemBase):
     ot_base_class_uuid: str | None = None
     starts_at_local: str
     name: str
@@ -38,30 +38,30 @@ class Class(OtfBaseModel):
     studio: Studio
 
 
-class CoachRating(OtfBaseModel):
+class CoachRating(OtfItemBase):
     id: str
     description: str
     value: int
 
 
-class ClassRating(OtfBaseModel):
+class ClassRating(OtfItemBase):
     id: str
     description: str
     value: int
 
 
-class Ratings(OtfBaseModel):
+class Ratings(OtfItemBase):
     coach: CoachRating
-    class_: ClassRating = Field(..., alias="class")
+    otf_class: ClassRating = Field(..., alias="class")
 
 
-class PerformanceSummaryEntry(OtfBaseModel):
+class PerformanceSummaryEntry(OtfItemBase):
     performance_summary_id: str = Field(..., alias="id")
     details: Details
     ratable: bool
-    class_: Class = Field(..., alias="class")
+    otf_class: Class = Field(..., alias="class")
     ratings: Ratings | None = None
 
 
-class PerformanceSummaryList(OtfBaseModel):
+class PerformanceSummaryList(OtfItemBase):
     summaries: list[PerformanceSummaryEntry]

otf_api/models/responses/studio_detail.py

@@ -2,17 +2,17 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Country(OtfBaseModel):
+class Country(OtfItemBase):
     country_id: int = Field(..., alias="countryId")
     country_currency_code: str = Field(..., alias="countryCurrencyCode")
     country_currency_name: str = Field(..., alias="countryCurrencyName")
     currency_alphabetic_code: str = Field(..., alias="currencyAlphabeticCode")
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     physical_address: str = Field(..., alias="physicalAddress")
     physical_address2: str | None = Field(..., alias="physicalAddress2")
     physical_city: str = Field(..., alias="physicalCity")
@@ -26,32 +26,32 @@ class StudioLocation(OtfBaseModel):
     longitude: float
 
 
-class Language(OtfBaseModel):
+class Language(OtfItemBase):
     language_id: None = Field(..., alias="languageId")
     language_code: None = Field(..., alias="languageCode")
     language_name: None = Field(..., alias="languageName")
 
 
-class StudioLocationLocalized(OtfBaseModel):
+class StudioLocationLocalized(OtfItemBase):
     language: Language
     studio_name: None = Field(..., alias="studioName")
     studio_address: None = Field(..., alias="studioAddress")
 
 
-class StudioProfiles(OtfBaseModel):
+class StudioProfiles(OtfItemBase):
     is_web: bool = Field(..., alias="isWeb")
     intro_capacity: int = Field(..., alias="introCapacity")
     is_crm: bool | None = Field(..., alias="isCrm")
 
 
-class SocialMediaLink(OtfBaseModel):
+class SocialMediaLink(OtfItemBase):
     id: str
     language_id: str = Field(..., alias="languageId")
     name: str
     value: str
 
 
-class StudioDetail(OtfBaseModel):
+class StudioDetail(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     studio_uuid: str = Field(..., alias="studioUUId")
     mbo_studio_id: int | None = Field(..., alias="mboStudioId")
@@ -100,12 +100,12 @@ class StudioDetail(OtfBaseModel):
     social_media_links: list[SocialMediaLink] = Field(..., alias="socialMediaLinks")
 
 
-class Pagination(OtfBaseModel):
+class Pagination(OtfItemBase):
     page_index: int = Field(..., alias="pageIndex")
     page_size: int = Field(..., alias="pageSize")
     total_count: int = Field(..., alias="totalCount")
     total_pages: int = Field(..., alias="totalPages")
 
 
-class StudioDetailList(OtfBaseModel):
+class StudioDetailList(OtfItemBase):
     studios: list[StudioDetail]

otf_api/models/responses/studio_services.py

@@ -2,34 +2,34 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Currency(OtfBaseModel):
+class Currency(OtfItemBase):
     currency_alphabetic_code: str = Field(..., alias="currencyAlphabeticCode")
 
 
-class DefaultCurrency(OtfBaseModel):
+class DefaultCurrency(OtfItemBase):
     currency_id: int = Field(..., alias="currencyId")
     currency: Currency
 
 
-class Country(OtfBaseModel):
+class Country(OtfItemBase):
     country_currency_code: str = Field(..., alias="countryCurrencyCode")
     default_currency: DefaultCurrency = Field(..., alias="defaultCurrency")
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     studio_location_id: int = Field(..., alias="studioLocationId")
     country: Country
 
 
-class Studio(OtfBaseModel):
+class Studio(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     studio_location: StudioLocation = Field(..., alias="studioLocation")
 
 
-class StudioService(OtfBaseModel):
+class StudioService(OtfItemBase):
     service_id: int = Field(..., alias="serviceId")
     service_uuid: str = Field(..., alias="serviceUUId")
     studio_id: int = Field(..., alias="studioId")
@@ -53,5 +53,5 @@ class StudioService(OtfBaseModel):
     studio: Studio
 
 
-class StudioServiceList(OtfBaseModel):
+class StudioServiceList(OtfItemBase):
     data: list[StudioService]

otf_api/models/responses/telemetry.py

@@ -3,15 +3,15 @@ from typing import Any
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Zone(OtfBaseModel):
+class Zone(OtfItemBase):
     start_bpm: int = Field(..., alias="startBpm")
     end_bpm: int = Field(..., alias="endBpm")
 
 
-class Zones(OtfBaseModel):
+class Zones(OtfItemBase):
     gray: Zone
     blue: Zone
     green: Zone
@@ -19,13 +19,13 @@ class Zones(OtfBaseModel):
     red: Zone
 
 
-class TreadData(OtfBaseModel):
+class TreadData(OtfItemBase):
     tread_speed: float = Field(..., alias="treadSpeed")
     tread_incline: float = Field(..., alias="treadIncline")
     agg_tread_distance: int = Field(..., alias="aggTreadDistance")
 
 
-class TelemetryItem(OtfBaseModel):
+class TelemetryItem(OtfItemBase):
     relative_timestamp: int = Field(..., alias="relativeTimestamp")
     hr: int
     agg_splats: int = Field(..., alias="aggSplats")
@@ -38,7 +38,7 @@ class TelemetryItem(OtfBaseModel):
     tread_data: TreadData | None = Field(None, alias="treadData")
 
 
-class Telemetry(OtfBaseModel):
+class Telemetry(OtfItemBase):
     member_uuid: str = Field(..., alias="memberUuid")
     class_history_uuid: str = Field(..., alias="classHistoryUuid")
     class_start_time: datetime = Field(..., alias="classStartTime")

otf_api/models/responses/telemetry_hr_history.py

@@ -1,19 +1,19 @@
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class MaxHr(OtfBaseModel):
+class MaxHr(OtfItemBase):
     type: str
     value: int
 
 
-class Zone(OtfBaseModel):
+class Zone(OtfItemBase):
     start_bpm: int = Field(..., alias="startBpm")
     end_bpm: int = Field(..., alias="endBpm")
 
 
-class Zones(OtfBaseModel):
+class Zones(OtfItemBase):
     gray: Zone
     blue: Zone
     green: Zone
@@ -21,7 +21,7 @@ class Zones(OtfBaseModel):
     red: Zone
 
 
-class HistoryItem(OtfBaseModel):
+class HistoryItem(OtfItemBase):
     max_hr: MaxHr = Field(..., alias="maxHr")
     zones: Zones
     change_from_previous: int = Field(..., alias="changeFromPrevious")
@@ -29,6 +29,6 @@ class HistoryItem(OtfBaseModel):
     assigned_at: str = Field(..., alias="assignedAt")
 
 
-class TelemetryHrHistory(OtfBaseModel):
+class TelemetryHrHistory(OtfItemBase):
     member_uuid: str = Field(..., alias="memberUuid")
     history: list[HistoryItem]

otf_api/models/responses/telemetry_max_hr.py

@@ -1,13 +1,13 @@
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class MaxHr(OtfBaseModel):
+class MaxHr(OtfItemBase):
     type: str
     value: int
 
 
-class TelemetryMaxHr(OtfBaseModel):
+class TelemetryMaxHr(OtfItemBase):
     member_uuid: str = Field(..., alias="memberUuid")
     max_hr: MaxHr = Field(..., alias="maxHr")

otf_api/models/responses/total_classes.py

@@ -1,8 +1,8 @@
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class TotalClasses(OtfBaseModel):
+class TotalClasses(OtfItemBase):
     total_in_studio_classes_attended: int = Field(..., alias="totalInStudioClassesAttended")
     total_otlive_classes_attended: int = Field(..., alias="totalOtliveClassesAttended")

otf_api/models/responses/workouts.py

@@ -4,16 +4,16 @@ from typing import Any
 
 from pydantic import Field, PrivateAttr
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class WorkoutType(OtfBaseModel):
+class WorkoutType(OtfItemBase):
     id: int
     display_name: str = Field(..., alias="displayName")
     icon: str
 
 
-class Workout(OtfBaseModel):
+class Workout(OtfItemBase):
     studio_number: str = Field(..., alias="studioNumber")
     studio_name: str = Field(..., alias="studioName")
     class_type: str = Field(..., alias="classType")
@@ -70,7 +70,7 @@ class Workout(OtfBaseModel):
         self._minute_by_minute_raw = data.get("minuteByMinuteHr")
 
 
-class WorkoutList(OtfBaseModel):
+class WorkoutList(OtfItemBase):
     workouts: list[Workout]
 
     @property

otf_api-0.3.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: otf-api
+Version: 0.3.0
+Summary: Python OrangeTheory Fitness API Client
+License: MIT
+Author: Jessica Smith
+Author-email: j.smith.git1@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+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: humanize (>=4.9.0,<5.0.0)
+Requires-Dist: inflection (==0.5.*)
+Requires-Dist: loguru (==0.7.2)
+Requires-Dist: pendulum[cli] (>=3.0.0,<4.0.0)
+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[cli] (>=4.1.0,<5.0.0)
+Requires-Dist: typer[cli] (>=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.
+
+## Installation
+```bash
+pip install otf-api
+```
+
+## Overview
+
+To use the API, you need to create an instance of the `Api` class, providing your email address and password. This will authenticate you with the API and allow you to make requests. When the `Api` object is created it automatically grabs your member details and home studio, to simplify the process of making requests.
+
+
+See the [examples](./examples) for more information on how to use the API.
+
+
+Disclaimer:
+This project is in no way affiliated with OrangeTheory Fitness.
+

otf_api-0.3.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+otf_api/__init__.py,sha256=TWtPFBlCS-SBoVXJ5VOR3o_IFWXDHItwKLuvpUpR5WU,238
+otf_api/api.py,sha256=41sJ6gIvqKnt3jyrqtbPYDuWGcQzmAtOBwiobBWGwKQ,35714
+otf_api/cli/__init__.py,sha256=WI-882LPH7Tj_ygDHqE5ehsas_u7m3ulsplS9vXKByk,151
+otf_api/cli/_utilities.py,sha256=epjEO9S6ag4HgJLXlTpCQXfdVQkqGWyNavp7DjwPL78,1753
+otf_api/cli/app.py,sha256=CGEjaDZW32jWpCAd-afyXNvuNfmT25Ts9HrXKvp5Mf0,6621
+otf_api/cli/bookings.py,sha256=yXednsIrpgfa8m26S-LXVDIEB8zCfj9J9osdz5c6Kko,8161
+otf_api/cli/prompts.py,sha256=iyodQXVa5v9VsrMxw0ob1okGRBDbWCSxhrNEylsOTEQ,5358
+otf_api/models/__init__.py,sha256=zewymgFsv81_s43hl6dPbFkACT17A2dTSY-nXoBk-Qg,1269
+otf_api/models/auth.py,sha256=DyFManp5RlfQinA0rWG_PjBZXrn2TpSM1-PJ630lamo,4073
+otf_api/models/base.py,sha256=oTDxyliK64GyTNx1bGTd-b9dfVn0r3YPpSycs2qEuIw,7285
+otf_api/models/responses/__init__.py,sha256=mhusNSeDyUqW9ki-HahX6xkmLud_9ighPS6yBX7T0k0,1753
+otf_api/models/responses/body_composition_list.py,sha256=RTC5bQpmMDUKqFl0nGFExdDxfnbOAGoBLWunjpOym80,12193
+otf_api/models/responses/book_class.py,sha256=bWURKEjLZWPzwu3HNP2zUmHWo7q7h6_z43a9KTST0Ec,15413
+otf_api/models/responses/bookings.py,sha256=0oQxdKTK-k30GVDKiVxTh0vvPTbrw78sqpQpYL7JnJU,11058
+otf_api/models/responses/cancel_booking.py,sha256=dmC5OP97Dy4qYT0l1KHYIitqSCo6M6Yqa0QztjgG_xQ,3859
+otf_api/models/responses/challenge_tracker_content.py,sha256=KKpSWyyg3viN0vf1Sg2zTMlMZExLe3I6wowmUPWvRCA,1423
+otf_api/models/responses/challenge_tracker_detail.py,sha256=o0y_ETfHmR1QhoOmvd83P6lfMZUPIwPlnS1V_po0dkE,3048
+otf_api/models/responses/classes.py,sha256=wmFMcFT-VLqOFB65pApffNPH6VFS150CEKHMq2MblI4,7090
+otf_api/models/responses/enums.py,sha256=Au8XhD-4T8ljiueUykFDc6Qz7kOoTlJ_kiDEx7nLVLM,1191
+otf_api/models/responses/favorite_studios.py,sha256=C5JSyiNijm6HQEBVrV9vPfZexSWQ1IlN0E3Ag0GeP_0,4982
+otf_api/models/responses/latest_agreement.py,sha256=aE8hbWE4Pgguw4Itah7a1SqwOLpJ6t9oODFwLQ8Wzo0,774
+otf_api/models/responses/lifetime_stats.py,sha256=3nWjXJoIcTV_R-Q-3SXo63Uj2xjkFtNXmzj_jPcZPyo,3339
+otf_api/models/responses/member_detail.py,sha256=WG_GjS_7mZQ72d5rgu7e1dc3e4fVaR5HRlxFtbJfct8,6024
+otf_api/models/responses/member_membership.py,sha256=_z301T9DrdQW9vIgnx_LeZmkRhvMVhkxrn_v6DDfCUk,995
+otf_api/models/responses/member_purchases.py,sha256=JoTk3hYjsq4rXogVivZxeFaM-j3gIChmIAGVldOU7rE,6085
+otf_api/models/responses/out_of_studio_workout_history.py,sha256=FwdnmTgFrMtQ8PngsmCv3UroWj3kDnQg6KfGLievoaU,1709
+otf_api/models/responses/performance_summary_detail.py,sha256=H5yWxGShR4uiXvY2OaniENburTGM7DKQjN7gvF3MG6g,1585
+otf_api/models/responses/performance_summary_list.py,sha256=1cbRX4bnLWwy6iYT6NmJXaT2AdZKGJvQMezkvcGLO58,1240
+otf_api/models/responses/studio_detail.py,sha256=CJBCsi4SMs_W5nrWE4hfCs1ugJ5t7GrH80hTv7Ie3eg,5007
+otf_api/models/responses/studio_services.py,sha256=mFDClPtU0HCk5fb19gjGKpt2F8n8kto7sj1pE_l4RdQ,1836
+otf_api/models/responses/telemetry.py,sha256=8dl8FKLeyb6jtqsZT7XD4JzXBMLlami448-Jt0tFbSY,1663
+otf_api/models/responses/telemetry_hr_history.py,sha256=vDcLb4wTHVBw8O0mGblUujHfJegkflOCWW-bnTXNCI0,763
+otf_api/models/responses/telemetry_max_hr.py,sha256=xKxH0fIlOqFyZv8UW98XsxF-GMoIs9gnCTAbu88ZQtg,266
+otf_api/models/responses/total_classes.py,sha256=WrKkWbq0eK8J0RC4qhZ5kmXnv_ZTDbyzsoRm7XKGlss,288
+otf_api/models/responses/workouts.py,sha256=4r6wQVY-yUsI83JYBpSCYhd7I5u-5OLvy1Vd1_gra88,3177
+otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otf_api-0.3.0.dist-info/AUTHORS.md,sha256=FcNWMxpe8KDuTq4Qau0SUXsabQwGs9TGnMp1WkXRnj8,123
+otf_api-0.3.0.dist-info/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
+otf_api-0.3.0.dist-info/METADATA,sha256=IZh9vTuZTckAY8AsAGmmF0eQWE5yaiHG2C2yPKM_nAE,2275
+otf_api-0.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+otf_api-0.3.0.dist-info/entry_points.txt,sha256=V2jhhfsUo3DeF0CA9HmKrMnvSoOldn9ShIzbApbeHTY,44
+otf_api-0.3.0.dist-info/RECORD,,

otf_api-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+otf=otf_api.cli:base_app
+

otf_api/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.2.2"

otf_api/classes_api.py

@@ -1,44 +0,0 @@
-import typing
-
-from otf_api.models.responses.classes import OtfClassList
-
-if typing.TYPE_CHECKING:
-    from otf_api import Api
-
-
-class ClassesApi:
-    def __init__(self, api: "Api"):
-        self._api = api
-        self.logger = api.logger
-
-        # simplify access to member_id and member_uuid
-        self._member_id = self._api.user.member_id
-        self._member_uuid = self._api.user.member_uuid
-
-    async def get_classes(
-        self, studio_uuids: list[str] | None = None, include_home_studio: bool = True
-    ) -> OtfClassList:
-        """Get the classes for the user.
-
-        Returns a list of classes that are available for the user, based on the studio UUIDs provided. If no studio
-        UUIDs are provided, it will default to the user's home studio.
-
-        Args:
-            studio_uuids (list[str] | None): The studio UUIDs to get the classes for. Default is None, which will\
-            default to the user's home studio only.
-            include_home_studio (bool): Whether to include the home studio in the classes. Default is True.
-
-        Returns:
-            OtfClassList: The classes for the user.
-        """
-
-        if not studio_uuids:
-            studio_uuids = [self._api.home_studio.studio_uuid]
-        elif include_home_studio and self._api.home_studio.studio_uuid not in studio_uuids:
-            studio_uuids.append(self._api.home_studio.studio_uuid)
-
-        path = "/v1/classes"
-
-        params = {"studio_ids": studio_uuids}
-        res = await self._api._classes_request("GET", path, params=params)
-        return OtfClassList(classes=res["items"])