nookipedia package¶

Subpackages¶

Submodules¶

nookipedia.nookipedia module¶

nookipedia.nookipedia.is_valid(data: Union[dict, list]) → bool¶

class nookipedia.nookipedia.Nookipedia(api_key: str, cached_api: bool = False)¶

Bases: object

Main API to be used to access the Nookipedia API.

Parameters

api_key – API key to access the Nookipedia API.
cached_api – Whether or not the API requests should be cached in memory.

async get_villager_raw(name: str) → dict¶

Parameters: name – The name of the villager to get

async get_fish_raw(name: str) → dict¶

Parameters: name – The name of the critter to get

async get_bug_raw(name: str) → dict¶

Parameters: name – The name of the critter to get

async get_villager_names() → List[str]¶: Returns a list of all villager names.

async get_fish_names() → List[str]¶: Returns a list of all fish names.

async get_bug_names() → List[str]¶: Returns a list of all bug names.

async get_category(name: str) → List[str]¶

Parameters: name – The name of the category to get.
Returns: A list of all names in that category.

async get_villager(name: str) → Optional[nookipedia.models.villager.Villager]¶

Parameters: name – The name of the villager to get.
Returns: Villager object, None if not found.

async get_villagers() → Optional[List[nookipedia.models.villager.Villager]]¶

Returns: List of Villager objects, None if not found.

async get_fish(name: str) → Optional[nookipedia.models.fish.Fish]¶

Parameters: name – The name of the Fish to get.
Returns: Fish object, None if not found.

async get_fishes() → Optional[List[nookipedia.models.fish.Fish]]¶

Returns: List of Fish objects, None if not found.

async get_bug(name: str) → Optional[nookipedia.models.bug.Bug]¶

Parameters: name – The name of the Bug to get.
Returns: Bug object, None if not found.

async get_bugs() → Optional[List[nookipedia.models.bug.Bug]]¶

Returns: List of Bug objects, None if not found.

Module contents¶