Python Wrapper for the Hyrule Compendium API
Project description
Python Package for the Hyrule Compendium API
This package comes with a few functions to help work with the Hyrule Compendium API and get all the data you want in a jiffy!
Recommendation
It's recommended that you read the API documentation before getting started.
Installation
pip install Hyrule-Compendium
Docs
categoryList()
Use
Print out the list of valid categories in the API.
Parameters
None
Example
Call:
list_of_categories = categoryList()
print(list_of_categories)
Output:
["creatures", "equipment", "materials", "monsters", "treasure"]
getCategory(categoryName)
Use
Gets all the JSON data from a valid category in the form of a python dictionary.
Parameters
- categoryName [type: string] - valid name of the category you want to fetch data from
Raises
- ValueError - if
categoryName
is not valid
Example
Call:
from pprint import pprint
pprint(getCategory("monsters"))
getEntry(entryName)
Use
Fetches data from a specific entry in the API.
Parameters
- entryName [type: string] - valid name of the entry you want to fetch data from
Raises
- ValueError - if
entryName
is not valid
Example
Call:
from pprint import pprint
pprint(getEntry("silver lynel"))
Output:
{'category': 'monsters',
'description': 'Silver Lynels are not to be trifled with. They have been '
"influenced by Ganon's fiendish magic, so they are the "
'strongest among the Lynel species, surpassing even the '
'strength of those with white manes. The term "silver" denotes '
'not only their color but also their rarity. The purple '
'stripes help them to stand out even more.',
'drops': ['lynel horn',
'lynel hoof',
'lynel guts',
'topaz',
'ruby',
'sapphire',
'diamond',
'star fragment'],
'id': 124,
'name': 'silver lynel'}
getAllData()
Use
Fetches all the data in the Hyrule Compendium API.
Parameters
None
Example
pprint(getAllData())
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
HyruleCompendium-0.0.3.tar.gz
(2.9 kB
view hashes)
Built Distribution
Close
Hashes for HyruleCompendium-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8385fc1cb1bb59aa53d3c80857f24fef1c6fb0e1782fe89fa4be233619c0f0e6 |
|
MD5 | 78b1283bb8246fa425a7e1976b1e89fd |
|
BLAKE2b-256 | 1ef56a9a21428792477c4424ae62d89009ef3c753527e3597720082ca599e61d |