The official python wrapper for the Hyrule Compendium API
Project description
pyrule compendium
The official python API wrapper for the Hyrule Compendium API.
Installation
pip3 install pyrule-compendium
Usage
Read code comments for detailed documentation.
from pyrule_compendium import compendium
print(compendium().get_all()) # get all entries
print(compendium().get_entry("silver_lynel")) # get a specific entry with it's name
print(compendium().get_entry(1)) # get a specific entry with it's ID
print(compendium().get_category("monsters")) # get all entries in a category
compendium().download_entry_image("silver_lynel", "silver_lynel.png") # download entry image
Notes
- If a key's value is
None
, it means that the key is marked as "unknown" in the compendium. - The response schema of
creatures
is different from the others, as it has two sub categories: food and non_food
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pyrule_compendium-2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 097e89e1e1b50798f01cedee8fdd69025b8c9c6bbd825367f7f0fc5910622af8 |
|
MD5 | 6f5d6e901c67000cdeeab4ed05293627 |
|
BLAKE2b-256 | 1612213e6f0b8743973cf6e505c5eae575101ac4b47d3da498287dcdae623624 |