MouseTools 4.0.0b0__tar.gz → 4.0.1__tar.gz

{mousetools-4.0.0b0 → mousetools-4.0.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 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.1/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: mousetools
+Version: 4.0.1
+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/
+Project-URL: issues, https://gitlab.com/caratozzoloxyz/public/MouseTools/-/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+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 Resort.
+
+This package makes no attempt to access data that would require individual user authentication. All data is pulled using public channels.
+
+## 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 AttractionFacilityChild
+
+pirates = AttractionFacilityChild("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+```
+
+
+All Facility Entities inherit from FacilityChildChannel. 
+
+```python
+print(pirates.name)
+# 'Pirates of the Caribbean'
+
+print(pirates.ancestor_theme_park_id)
+# '80007944;entityType=theme-park'
+```
+
+In order to access a facility's live data, you'll need a FacilityStatusChildChannel. Fortunately for you, this can be quickly done from the facility object.
+```python
+fs = pirates.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 or facility enums to get access to a destination facility's children channels.
+
+```python
+from mousetools.channels.facilities import FacilityChannel, ThemeParkFacilityChild
+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 = ThemeParkFacilityChild(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.1/README.md

@@ -0,0 +1,92 @@
+# 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 Resort.
+
+This package makes no attempt to access data that would require individual user authentication. All data is pulled using public channels.
+
+## 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 AttractionFacilityChild
+
+pirates = AttractionFacilityChild("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+```
+
+
+All Facility Entities inherit from FacilityChildChannel. 
+
+```python
+print(pirates.name)
+# 'Pirates of the Caribbean'
+
+print(pirates.ancestor_theme_park_id)
+# '80007944;entityType=theme-park'
+```
+
+In order to access a facility's live data, you'll need a FacilityStatusChildChannel. Fortunately for you, this can be quickly done from the facility object.
+```python
+fs = pirates.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 or facility enums to get access to a destination facility's children channels.
+
+```python
+from mousetools.channels.facilities import FacilityChannel, ThemeParkFacilityChild
+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 = ThemeParkFacilityChild(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.1/mousetools/__init__.py

@@ -0,0 +1,4 @@
+import logging
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())