pyrule-compendium 1.0.0

The official python wrapper for the Hyrule Compendium API

The official python wrapper for the Hyrule Compendium API, forked from the unnoficial [shaunikm/Hyrule-Compendium-python-client](shaunikm/Hyrule-Compendium-python-client).

It's recommended that you read the API documentation before getting started.

Installation

pip3 install git+https://github.com/gadhagod/pyrule-compendium

PyPi package coming soon.

Docs

All functions are attributes of class compendium.

---

getCategory(category)

Get all entries in a category.

Parameters

• category [type: string] - name of category

---

getEntry(entry)

Get an entry. Parameters

• entry [type: string, int] - name or ID of entry

---

getAll()

Get all data.

Parameters
None

---

Hosting locally

You can configure the URL to make requests to by setting the compendium class parameter url. See here to host the server locally.

Shoutouts

Thanks to @shaunikm for the original code.