PyPokéClient

Synchronous and asynchronous clients for fetching data from PokéAPI.

📌 Features

• Coverage: covers all PokéAPI endpoints.
• Data validation: uses Pydantic dataclasses to model and validate API responses.
• Flexibility: provides both synchronous and asynchronous clients.
• Caching: supports an optional local caching system for faster responses and to help comply with PokéAPI's Fair Use Policy.

Please refer to the documentation for more details about the package.

📦 Installation

# It is highly recommended to use uv
uv add pypokeclient

# You can also install the package with pip
pip install pypokeclient

🛠️ How to use

You can choose between the synchronous and asynchronous clients.

Sync

from pypokeclient import Client

# Simple usage
client = Client()
pokemon = client.get_pokemon("fuecoco")

# Or with context manager
with Client() as client:
    pokemon = client.get_pokemon("fuecoco")

Async

import asyncio

from pypokeclient import AsyncClient


async def fetch_data():
    # Simple usage
    client = AsyncClient()
    pokemon = await client.get_pokemon("fuecoco")

    # With context manager
    async with AsyncClient() as client:
        pokemon = await client.get_pokemon("fuecoco")


asyncio.run(fetch_data())

No client

If you want to build your own client, including the caching mechanism, while still benefiting from Pydantic dataclasses, you can use the data models directly.

import requests
from pypokeclient._api import Pokemon

resp = requests.get("https://pokeapi.co/api/v2/pokemon/fuecoco")
pokemon = Pokemon(**resp.json())

💾 Caching the results

[!IMPORTANT] Please refer to the hishel documentation for more details about the caching system.

import logging

from hishel import SyncSqliteStorage
from hishel.httpx import SyncCacheClient
from pypokeclient import Client

# Set up the logger
logger = logging.getLogger("pypokeclient")
logger.setLevel(logging.INFO)
console_handler = logging.StreamHandler()
console_handler.setFormatter(logging.Formatter("%(name)s - %(levelname)s - %(message)s"))
logger.addHandler(console_handler)

# Set up the underlying HTTP client
http_client = SyncCacheClient(storage=SyncSqliteStorage(database_path="pypokeclient_cache.db"))

# Fetch data
with Client(http_client) as sync_client:
    pokemon = sync_client.get_pokemon("fuecoco")
    pokemon = sync_client.get_pokemon("fuecoco")

    # The sprites are cached too
    sprite = sync_client.get_sprite(pokemon.sprites.front_default)
    sprite = sync_client.get_sprite(pokemon.sprites.front_default)

    # You can also save the sprites locally if needed
    sprite.save("fuecoco.png")

The output will be

pypokeclient - INFO - The synchronous client is ready and using the cache at .cache\hishel\pypokeclient_cache.db'.
pypokeclient - INFO - [200] Request to https://pokeapi.co/api/v2/pokemon/fuecoco.
pypokeclient - INFO - [200] Cached request to https://pokeapi.co/api/v2/pokemon/fuecoco.
pypokeclient - INFO - [200] Request to https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/909.png.
pypokeclient - INFO - [200] Cached request to https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/909.png.
pypokeclient - INFO - Closed session for the synchronous client.

📝 License

This project is MIT licensed.