MouseTools 2.1.2.dev2__py3-none-any.whl → 3.0.0__py3-none-any.whl

{MouseTools-2.1.2.dev2.dist-info → MouseTools-3.0.0.dist-info}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Scott Caratozzolo
+Copyright (c) 2024 Scott Caratozzolo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MouseTools-3.0.0.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: MouseTools
+Version: 3.0.0
+Summary: An unofficial Python wrapper for Disney's API
+Author: Scott Caratozzolo
+Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx >=0.27.2
+Requires-Dist: tzdata >=2024.1
+
+# MouseTools
+[![PyPI version](https://badge.fury.io/py/MouseTools.svg)](https://badge.fury.io/py/MouseTools) [![Downloads](https://pepy.tech/badge/mousetools)](https://pepy.tech/project/mousetools)
+
+
+An unofficial Python wrapper for the Disney API. Data is pulled directly from Disney. This package supports Walt Disney World and Disneyland.
+
+Read the [documentation](https://caratozzoloxyz.gitlab.io/public/MouseTools/).
+
+
+### Installation
+You can install using pip:
+```bash
+pip install MouseTools
+```
+You can also install directly from this repo in case of any changes not uploaded to Pypi.
+```bash
+pip install git+https://gitlab.com/caratozzoloxyz/public/MouseTools
+```
+
+### Quick Start
+
+Define an entity object directly.
+
+```python
+from mousetools.entities import Attraction
+
+big_thunder = Attraction("80010110")
+
+print(big_thunder.name)
+#> 'Big Thunder Mountain Railroad'
+
+print(big_thunder.ancestor_theme_park_id)
+#> '80007944'
+
+print(big_thunder.get_status())
+#> 'OPERATING'
+
+print(big_thunder.get_wait_time())
+#> 45
+
+```
+
+Use the already created destination objects to get children entities.
+
+```python
+from mousetools.entities import WALT_DISNEY_WORLD_DESTINATION, DISNEYLAND_RESORT_DESTINATION
+from mousetools.ids import FacilityServiceEntityTypes
+
+print(WALT_DISNEY_WORLD_DESTINATION.get_children_entity_ids(FacilityServiceEntityTypes.ENTERTAINMENT_VENUES))
+#> ['10460', '80008033', '80008259']
+
+print(DISNEYLAND_RESORT_DESTINATION.get_children_entity_ids(FacilityServiceEntityTypes.RESORT_AREAS))
+#> ['330338', '15597760']
+```
+
+### License
+This project is distributed under the MIT license. For more information see [LICENSE](https://gitlab.com/caratozzoloxyz/public/MouseTools/-/blob/master/LICENSE?ref_type=heads)
+
+### Disclaimer
+This project is in no way affiliated with The Walt Disney Company and all use of Disney Services is subject to the [Disney Terms of Use](https://disneytermsofuse.com/).
+
+This package uses the [ThemeParks.wiki API](https://themeparks.wiki/). 

MouseTools-3.0.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+mousetools/__init__.py,sha256=S--2ZSxhyURuaycgXIvm3J4PvkdonoBAzZaDBs_oNmM,193
+mousetools/auth.py,sha256=ogbssFgG4Fmjuce2ppH96nlh3BJNXjOTWuSVbVM4XGQ,2372
+mousetools/exceptions.py,sha256=0omdWcFu99r1XgVWQpn2jemgR34-lkfOeXvWFyCFILM,536
+mousetools/ids.py,sha256=Gsnb9tkQ7uyDacbGJHGdYVv-4-FyfEI3BplMrYW67PY,4248
+mousetools/urls.py,sha256=2WQMnUo080QxwFXOs5t9X5893QofQ5z3by_vkQsCDpo,233
+mousetools/entities/__init__.py,sha256=6UCrjuEJ_DboUhQHYrn16GL2VdCPw13or4fuU85Q4hM,1437
+mousetools/entities/attraction.py,sha256=ACKNG_5xMM2kXws_76SmcfqaqErxRRzEER2XGsMtUpA,366
+mousetools/entities/base.py,sha256=G7i8WQhRoWAp7eDx3_c9I_A9rejnC9TwKchRAtL00_c,16570
+mousetools/entities/character.py,sha256=ifdzEZC9r3W_ZBoYzjgsKMWbT3TmmDo98wg7letqaoU,363
+mousetools/entities/destination.py,sha256=MsQ713DRoWlBoEHSKqtt4qctArHXUqk1ukYU_tnNh5o,520
+mousetools/entities/dining_event.py,sha256=9aa7MF5FPQdLcwHDgm77KT6kmba3IVBx_KyhEPXu9XU,370
+mousetools/entities/dinner_show.py,sha256=Hbdg0rOmH9d5QOSxcArG594rfFnTLKLnw5uhtjnWO9w,368
+mousetools/entities/entertainment.py,sha256=NYHcZlU1odPsobQJMdV3s82zREfqD8ZbNQXl0uRw21Q,375
+mousetools/entities/entertainment_venue.py,sha256=53WzFLnjoKZYaz3GV-B9km2UNiMYKX7Ir07w1TwYSn8,391
+mousetools/entities/event.py,sha256=_u_IYJM55FwPpf_RVlqYK2ryaWq-5gznhBqRlSwnepg,351
+mousetools/entities/guest_services.py,sha256=p1NP1vnkEXOv1OMKRiWPhQ77Cikok3jXAOu3PJQXV_o,376
+mousetools/entities/land.py,sha256=oT8wSBuLyBe34kRhl2O-DJyA1np1O-X-YsJoRnqVhFI,348
+mousetools/entities/menu.py,sha256=sZPanyB7zuznRC-B4wIJbKWRyM_gwVAAVnLKsBjG5-A,353
+mousetools/entities/merchandise_facility.py,sha256=xtU_yuhGi4seS7e2ClMtsaqmw-SBIs5N_7gFz1FxgcA,395
+mousetools/entities/park.py,sha256=ZtXo4hyyJFIRQ7l-GMmBj9rMH14KUQ84f5RVZ0VLBcI,1221
+mousetools/entities/point_of_interest.py,sha256=h-CroI3QwuLGvGmGHRS3yQO8OQB-5lplLmQHlvLHDNo,385
+mousetools/entities/resort.py,sha256=aKNrLVa_KRTHPLbY2IHMp7sgSesBT2gR0u6XJBaEt14,354
+mousetools/entities/resort_area.py,sha256=COiwcB8aXOFWmjw_RYOYgJ35SHb8z_QaBKyTHA2OGZQ,368
+mousetools/entities/restaurant.py,sha256=QTWPhmQb0kqRUNdLwqCpc3LGpQ35DvXdWFXQXgtgCBo,366
+mousetools/mixins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mousetools/mixins/disney.py,sha256=9EW_TPl3LQy9EHyivxVSOKJ1TWjfPHHdwnDQJK4c-b0,1854
+mousetools/mixins/themeparksapi.py,sha256=gxep2vBXMSSVh1c3Yjt7oaIyCjhQfGtbSHXysbhazbs,4321
+MouseTools-3.0.0.dist-info/LICENSE,sha256=xX4HoDU-zdafl3yEfIaspkvqHPaaXhuDwkJ6qhDMUIo,1074
+MouseTools-3.0.0.dist-info/METADATA,sha256=_JnEyRTQkzO-Y7Fz0ms5_nxc0nT8Fy6hNbY2o_bfAYo,2491
+MouseTools-3.0.0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+MouseTools-3.0.0.dist-info/top_level.txt,sha256=7nanLN103J_xJn6HK6yuyqqlDgltCsQY2-ArRXx1Ukk,11
+MouseTools-3.0.0.dist-info/RECORD,,

{MouseTools-2.1.2.dev2.dist-info → MouseTools-3.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (74.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mousetools/__init__.py

@@ -1,27 +1,7 @@
-"""
-init
-expose classes and modules
-"""
-from mousetools.parks import Park
-from mousetools.entertainmentvenues import EntertainmentVenue
-from mousetools.attractions import Attraction
-from mousetools.entertainments import Entertainment
-from mousetools.characters import Character
-from mousetools.facilities import Facility
-from mousetools.pointsofinterest import PointOfInterest
-from mousetools.destinations import Destination
-import mousetools.ids as ids
+import logging
 
-__version__ = "2.1.2-dev.2" # will be set at runtime
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
-
-__all__ = [
-    "Destination",
-    "Park",
-    "EntertainmentVenue",
-    "Attraction",
-    "Entertainment",
-    "Facility",
-    "Character",
-    "PointOfInterest",
-    ]
+__version__ = "3.0.0"  # will be set at runtime
+logger.info(f"MouseTools version: {__version__}")

mousetools/auth.py

@@ -1,42 +1,70 @@
-import requests
-import json
-from datetime import datetime, timedelta
-
-
-def disney_authentication():
-    """Gets an authentication (access) token from Disney and returns it"""
-
-    headers = {
-        'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36',
-        'Accept-Language' : 'en_US',
-        'Cache-Control' : '0',
-        'Accept' : 'application/json',
-        'Content-Type' : 'application/x-www-form-urlencoded',
-        'Connection' : 'keep-alive',
-        'Proxy-Connection' : 'keep-alive',
-        'Accept-Encoding' : 'gzip, deflate'
-    }
-    auth = requests.get("https://disneyworld.disney.go.com/authentication/get-client-token", headers=headers, timeout=10).json()
-    return auth['access_token'], auth['expires_in']
-
-
-time_of_expire = None
-access_token = None
-
-def get_headers():
-    """Creates the headers to send during the request and returns it"""
-
-    global time_of_expire
-    global access_token
-
-    if time_of_expire == None or (datetime.now() > time_of_expire):
-        access_token, expires_in = disney_authentication()
-        time_of_expire = datetime.now() + timedelta(seconds=(expires_in-10))
-
-    headers = {"Authorization":"BEARER {}".format(access_token), "User-Agent":'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36', "Content-Type":"application/json;charset=UTF-8","Accept":"*/*"}
-
-    return headers
-
-if __name__ == '__main__':
-
-    print(get_headers())
+import typing
+from datetime import datetime, timedelta
+
+import httpx
+
+
+class Authentication:
+    def __init__(self):
+        self.time_of_expire: typing.Optional[datetime] = None
+        self.access_token: typing.Optional[str] = None
+
+    @staticmethod
+    def authenticate() -> typing.Tuple[str, int]:
+        """Gets an access token from Disney and the token's expiration time
+
+        Returns:
+            (typing.Tuple[str, int]): Access token to the api and how long until it expires
+        """
+
+        headers = {
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
+            "Accept-Language": "en-US,en;q=0.9",
+            "Cache-Control": "max-age=0",
+            "Accept": "application/json",
+            "Content-Type": "application/x-www-form-urlencoded",
+            "Connection": "keep-alive",
+            "Proxy-Connection": "keep-alive",
+            "Accept-Encoding": "gzip, deflate",
+        }
+
+        body = {
+            "grant_type": "assertion",
+            "assertion_type": "public",
+            "client_id": "TPR-DLR-LBSDK.AND-PROD",
+        }
+
+        response = httpx.post(
+            "https://authorization.go.com/token",
+            headers=headers,
+            params=body,
+            timeout=10,
+        )
+        response.raise_for_status()
+        auth = response.json()
+
+        return auth["access_token"], int(auth["expires_in"])
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        """Creates the headers to send during the request
+
+        Returns:
+            (typing.Dict[str, str]): Headers for the request
+        """
+
+        if self.time_of_expire is None or (datetime.now() > self.time_of_expire):
+            access_token, expires_in = self.authenticate()
+            self.time_of_expire = datetime.now() + timedelta(seconds=(expires_in - 10))
+            self.access_token = access_token
+
+        headers = {
+            "Authorization": f"BEARER {self.access_token}",
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36",
+            "Content-Type": "application/json",
+            "Accept": "*/*",
+        }
+
+        return headers
+
+
+auth_obj = Authentication()

mousetools/entities/__init__.py

@@ -0,0 +1,41 @@
+from mousetools.entities.attraction import Attraction
+from mousetools.entities.character import Character
+from mousetools.entities.destination import Destination
+from mousetools.entities.dining_event import DiningEvent
+from mousetools.entities.dinner_show import DinnerShow
+from mousetools.entities.entertainment import Entertainment
+from mousetools.entities.entertainment_venue import EntertainmentVenue
+from mousetools.entities.event import Event
+from mousetools.entities.guest_services import GuestServices
+from mousetools.entities.land import Land
+from mousetools.entities.merchandise_facility import MerchandiseFacility
+from mousetools.entities.park import ThemePark, WaterPark
+from mousetools.entities.point_of_interest import PointOfInterest
+from mousetools.entities.resort import Resort
+from mousetools.entities.resort_area import ResortArea
+from mousetools.entities.restaurant import Restaurant
+from mousetools.ids import DestinationIds
+
+WALT_DISNEY_WORLD_DESTINATION = Destination(DestinationIds.WALT_DISNEY_WORLD)
+DISNEYLAND_RESORT_DESTINATION = Destination(DestinationIds.DISNEYLAND_RESORT)
+
+
+__all__ = [
+    "Attraction",
+    "Character",
+    "GuestServices",
+    "Entertainment",
+    "Destination",
+    "ThemePark",
+    "WaterPark",
+    "EntertainmentVenue",
+    "MerchandiseFacility",
+    "Restaurant",
+    "Resort",
+    "ResortArea",
+    "DiningEvent",
+    "DinnerShow",
+    "Event",
+    "Land",
+    "PointOfInterest",
+]

mousetools/entities/attraction.py

@@ -0,0 +1,12 @@
+from mousetools.entities.base import EntityBase
+from mousetools.ids import FacilityServiceEntityTypes
+
+
+class Attraction(EntityBase):
+    """Class for Attraction Entities."""
+
+    def __init__(self, entity_id: str):
+        super().__init__(
+            entity_id=entity_id,
+            facility_service_entity_type=FacilityServiceEntityTypes.ATTRACTIONS,
+        )