MouseTools 3.1.0.dev1__tar.gz → 4.0.0__tar.gz

{mousetools-3.1.0.dev1 → mousetools-4.0.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Scott Caratozzolo
+Copyright (c) 2018-2025 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-4.0.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: mousetools
+Version: 4.0.0
+Summary: An unofficial Python wrapper for Disney's API
+Author: Scott Caratozzolo
+License-Expression: MIT
+Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
+Project-URL: documentation, https://caratozzoloxyz.gitlab.io/public/MouseTools/
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: <4.0,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: pycryptodome>=3.22.0
+Requires-Dist: tzdata>=2024.1
+Dynamic: license-file
+
+# 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.
+
+### 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
+```
+
+# Usage
+
+The Disney API considers everything an entity. Attractions, resorts, restaurants, etc, are all entities. Entities belong to channels, or a group of entities.
+
+## Getting Started
+
+You'll want to create a facility channel object.
+
+```python
+from mousetools.channels.facilities import Attraction
+
+pirates = Attraction("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+```
+
+
+All Facility Entities inherit from [FacilityChildChannel][mousetools.channels.facilities.FacilityChildChannel]. 
+
+```python
+print(pirates.name)
+# 'Pirates of the Caribbean'
+
+print(big_thunder.ancestor_theme_park_id)
+# '80007944;entityType=theme-park'
+```
+
+In order to access a facility's live data, you'll need a [FacilityStatusChildChannel][mousetools.channels.facilitystatus.FacilityStatusChildChannel]. Fortunately for you, this can be quickly done from the facility object.
+```python
+fs = a.get_facility_status_channel()
+print(fs.get_wait_time())
+# 15
+
+print(fs.get_status())
+# 'Operating'
+```
+
+Alternatively, you can create the object yourself.
+```python
+from mousetools.channels.facilitystatus import FacilityStatusChannel
+
+fsc = FacilityStatusChannel("wdw.facilitystatus.1_0.80010177;entityType=Attraction", lazy_load=False)
+print(fs.last_update)
+# 2025-05-15 22:52:52.176069-04:00
+```
+
+***NOTE: All channels are lazy loaded, meaning there is no request sent to load the data until an object's attributes are accessed. This allows objects to be created faster, and reduce requests to Disney's servers until the data is actually needed.***
+
+
+For ease of use, you can use the available [channel enums][mousetools.channels.enums] or [facility enums][mousetools.channels.facilities.enums] to get access to a destination facility's children channels.
+
+```python
+from mousetools.channels.facilities import FacilityChannel, ThemePark
+from mousetools.channel.facilities.enums import WaltDisneyWorldParkChannelIds
+from mousetools.channels.facilitystatus import FacilityStatusChannel
+from mousetools.channels.enums import WDWCouchbaseChannels, DLRCouchbaseChannels
+
+wdw = FacilityChannel(WDWCouchbaseChannels.FACILITIES)
+print(list(wdw.get_children_attractions()))
+# [Attraction(wdw.facilities.1_0.en_us.123), Attraction(wdw.facilities.1_0.en_us.456), ...]
+
+dlr = FacilityStatusChannel(DLRCouchbaseChannels.FACILITY_STATUS)
+print(dlr.get_children_channel_ids())
+# ["dlr.facilitystatus.1_0.123", "dlr.facilitystatus.1_0.456", ...]
+
+mk = ThemePark(WaltDisneyWorldParkChannelIds.MAGIC_KINGDOM, lazy_load=False)
+print(mk.description)
+# "Enter a Land Where Fantasy Reigns"
+```
+
+### 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/).

mousetools-4.0.0/README.md

@@ -0,0 +1,90 @@
+# 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.
+
+### 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
+```
+
+# Usage
+
+The Disney API considers everything an entity. Attractions, resorts, restaurants, etc, are all entities. Entities belong to channels, or a group of entities.
+
+## Getting Started
+
+You'll want to create a facility channel object.
+
+```python
+from mousetools.channels.facilities import Attraction
+
+pirates = Attraction("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+```
+
+
+All Facility Entities inherit from [FacilityChildChannel][mousetools.channels.facilities.FacilityChildChannel]. 
+
+```python
+print(pirates.name)
+# 'Pirates of the Caribbean'
+
+print(big_thunder.ancestor_theme_park_id)
+# '80007944;entityType=theme-park'
+```
+
+In order to access a facility's live data, you'll need a [FacilityStatusChildChannel][mousetools.channels.facilitystatus.FacilityStatusChildChannel]. Fortunately for you, this can be quickly done from the facility object.
+```python
+fs = a.get_facility_status_channel()
+print(fs.get_wait_time())
+# 15
+
+print(fs.get_status())
+# 'Operating'
+```
+
+Alternatively, you can create the object yourself.
+```python
+from mousetools.channels.facilitystatus import FacilityStatusChannel
+
+fsc = FacilityStatusChannel("wdw.facilitystatus.1_0.80010177;entityType=Attraction", lazy_load=False)
+print(fs.last_update)
+# 2025-05-15 22:52:52.176069-04:00
+```
+
+***NOTE: All channels are lazy loaded, meaning there is no request sent to load the data until an object's attributes are accessed. This allows objects to be created faster, and reduce requests to Disney's servers until the data is actually needed.***
+
+
+For ease of use, you can use the available [channel enums][mousetools.channels.enums] or [facility enums][mousetools.channels.facilities.enums] to get access to a destination facility's children channels.
+
+```python
+from mousetools.channels.facilities import FacilityChannel, ThemePark
+from mousetools.channel.facilities.enums import WaltDisneyWorldParkChannelIds
+from mousetools.channels.facilitystatus import FacilityStatusChannel
+from mousetools.channels.enums import WDWCouchbaseChannels, DLRCouchbaseChannels
+
+wdw = FacilityChannel(WDWCouchbaseChannels.FACILITIES)
+print(list(wdw.get_children_attractions()))
+# [Attraction(wdw.facilities.1_0.en_us.123), Attraction(wdw.facilities.1_0.en_us.456), ...]
+
+dlr = FacilityStatusChannel(DLRCouchbaseChannels.FACILITY_STATUS)
+print(dlr.get_children_channel_ids())
+# ["dlr.facilitystatus.1_0.123", "dlr.facilitystatus.1_0.456", ...]
+
+mk = ThemePark(WaltDisneyWorldParkChannelIds.MAGIC_KINGDOM, lazy_load=False)
+print(mk.description)
+# "Enter a Land Where Fantasy Reigns"
+```
+
+### 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/).

{mousetools-3.1.0.dev1 → mousetools-4.0.0}/mousetools/__init__.py

@@ -3,5 +3,5 @@ import logging
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-__version__ = "3.1.0-dev.1"  # will be set at runtime
+__version__ = "0.0.0"  # will be set at runtime
 logger.info(f"MouseTools version: {__version__}")

mousetools-4.0.0/mousetools/api/menu.py

@@ -0,0 +1,433 @@
+import typing
+
+from mousetools.auth import auth_obj
+from mousetools.mixins.disney import DisneyAPIMixin
+
+# menus -> menu -> menugroups -> menuitems
+
+
+class MenuItem:
+    def __init__(self, raw_item_data: dict, parent_resturant_id: typing.Optional[str] = None):
+        self._raw_item_data = raw_item_data
+        self._parent_restaurant_id = parent_resturant_id
+
+    def __repr__(self) -> str:
+        return f"MenuItem(entity_id={self.entity_id}, parent_resturant_id={self._parent_restaurant_id})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu item.
+        """
+        try:
+            return self._raw_item_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["PCShort"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["PCLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["MobileShort"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["MobileLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mickey_check(self) -> typing.Optional[bool]:
+        """
+        Whether the menu item is mickey check.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu item is mickey check.
+        """
+        try:
+            return self._raw_item_data["mickeyCheck"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_description(self) -> typing.Optional[str]:
+        """
+        The long description of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long description of the menu item.
+        """
+        try:
+            return self._raw_item_data["descriptions"]["PCLong"]["text"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_description(self) -> typing.Optional[str]:
+        """
+        The short description of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short description of the menu item.
+        """
+        try:
+            return self._raw_item_data["descriptions"]["MobileShort"]["text"]
+        except KeyError:
+            return None
+
+    @property
+    def default_selection(self) -> typing.Optional[bool]:
+        """
+        Whether the menu item is the default selection.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu item is the default selection.
+        """
+        try:
+            return self._raw_item_data["defaultSelection"]
+        except KeyError:
+            return None
+
+    @property
+    def prices(self) -> typing.Optional[dict]:
+        """
+        The prices of the menu item.
+
+        Returns:
+            (typing.Optional[dict]): The prices of the menu item.
+        """
+        try:
+            return self._raw_item_data["prices"]
+        except KeyError:
+            return None
+
+    @property
+    def per_serving_without_tax(self) -> typing.Optional[float]:
+        """
+        The per serving without tax of the menu item.
+
+        Returns:
+            (typing.Optional[float]): The per serving without tax of the menu item.
+        """
+        try:
+            return self._raw_item_data["prices"]["PerServing"]["withoutTax"]
+        except KeyError:
+            return None
+
+
+class MenuGroup:
+    def __init__(self, raw_menu_group_data: dict, parent_restaurant_id: typing.Optional[str] = None):
+        self._raw_menu_group_data = raw_menu_group_data
+        self._parent_restaurant_id = parent_restaurant_id
+
+    def __str__(self) -> str:
+        return f"MenuGroup(menu_group_type={self.menu_group_type}, parent_restaurant_id={self._parent_restaurant_id})"
+
+    @property
+    def menu_group_type(self) -> typing.Optional[str]:
+        """
+        The type of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["menuGroupType"]
+        except KeyError:
+            return None
+
+    @property
+    def multiple_price_types(self) -> typing.Optional[bool]:
+        """
+        Whether the menu group has multiple price types.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu group has multiple price types.
+        """
+        try:
+            return self._raw_menu_group_data["multiplePriceTypes"]
+        except KeyError:
+            return None
+
+    @property
+    def mickey_check_items(self) -> typing.Optional[bool]:
+        """
+        Whether the menu group has mickey check items.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu group has mickey check items.
+        """
+        try:
+            return self._raw_menu_group_data["mickeyCheckItems"]
+        except KeyError:
+            return None
+
+    @property
+    def names(self) -> typing.Optional[dict]:
+        """
+        The names of the menu group.
+
+        Returns:
+            (typing.Optional[dict]): The names of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["PCShort"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["PCLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["MobileShort"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["MobileLong"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_items(self) -> typing.Optional[list[MenuItem]]:
+        """
+        The menu items of the menu group.
+
+        Returns:
+            (typing.Optional[list[MenuItem]]): The menu items of the menu group.
+        """
+        try:
+            return [MenuItem(i, self._parent_restaurant_id) for i in self._raw_menu_group_data["menuItems"]]
+        except KeyError:
+            return None
+
+
+class Menu:
+    def __init__(self, raw_menu_data: dict, parent_restaurant_id: typing.Optional[str] = None):
+        self._raw_menu_data = raw_menu_data
+        self._parent_restaurant_id = parent_restaurant_id
+
+    def __str__(self):
+        return f"Menu(entity_id={self.entity_id}, menu_type={self.menu_type}, parent_restaurant_id={self._parent_restaurant_id})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu.
+        """
+        try:
+            return self._raw_menu_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_type(self) -> typing.Optional[str]:
+        """
+        The type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu.
+        """
+        try:
+            return self._raw_menu_data["menuType"]
+        except KeyError:
+            return None
+
+    @property
+    def localized_menu_type(self) -> typing.Optional[str]:
+        """
+        The localized type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The localized type of the menu.
+        """
+        try:
+            return self._raw_menu_data["localizedMenuType"]
+        except KeyError:
+            return None
+
+    @property
+    def experience_type(self) -> typing.Optional[str]:
+        """
+        The experience type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The experience type of the menu.
+        """
+        try:
+            return self._raw_menu_data["experienceType"]
+        except KeyError:
+            return None
+
+    @property
+    def service_style(self) -> typing.Optional[str]:
+        """
+        The service style of the menu.
+
+        Returns:
+            (typing.Optional[str]): The service style of the menu.
+        """
+        try:
+            return self._raw_menu_data["serviceStyle"]
+        except KeyError:
+            return None
+
+    @property
+    def primary_cuisine_type(self) -> typing.Optional[str]:
+        """
+        The primary cuisine type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The primary cuisine type of the menu.
+        """
+        try:
+            return self._raw_menu_data["primaryCuisineType"]
+        except KeyError:
+            return None
+
+    @property
+    def secondary_cuisine_type(self) -> typing.Optional[str]:
+        """
+        The secondary cuisine type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The secondary cuisine type of the menu.
+        """
+        try:
+            return self._raw_menu_data["secondaryCuisineType"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_groups(self) -> list[MenuGroup]:
+        """
+        The menu groups of the menu.
+
+        Returns:
+            (list[MenuGroup]): The menu items of the menu.
+        """
+        try:
+            return [MenuGroup(i, self._parent_restaurant_id) for i in self._raw_menu_data["menuGroups"]]
+        except KeyError:
+            return []
+
+
+class Menus(DisneyAPIMixin):
+    """Class for Menu Entities."""
+
+    _menu_service_base = f"{auth_obj._environments['serviceMenuUrl']}/diningMenuSvc/orchestration/menus"
+
+    def __init__(self, restaurant_channel_id: str, lazy_load: bool = True):
+        self.entity_id = restaurant_channel_id.rsplit(".", 1)[-1]
+        self._menu_service_url = f"{self._menu_service_base}/{self.entity_id}"
+
+        if lazy_load:
+            self.disney_data: typing.Optional[dict] = None
+        else:
+            self.disney_data = self.get_disney_data(self.entity_id)
+
+    def __str__(self):
+        return f"Menus(entity_id={self.entity_id})"
+
+    def __repr__(self):
+        return f"Menus(restaurant_channel_id={self.entity_id})"
+
+    @property
+    def menus(self) -> list[Menu]:
+        """
+        Returns a list of all the menus associated with this entity.
+
+        Returns:
+            (list[Menu]): List of Menu objects that are associated with this entity.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._menu_service_url)
+        try:
+            return [Menu(i, self.entity_id) for i in self.disney_data["menus"]]
+        except KeyError:
+            return []