Skip to main content

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

Documentation

Detailed docs and guide here.

Basic Usage

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().get_image("silver_lynel").download() # download entry image

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrule-compendium-2.4.1.tar.gz (8.4 kB view hashes)

Uploaded Source

Built Distribution

pyrule_compendium-2.4.1-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page