Skip to main content

A flexible and easy to use pokemon library.

Project description

PokeLance

logo

license black mypy ruff stars downloads commits py versions

A flexible, statically typed and easy to use pokeapi wrapper for python 🚀


Features:

  • Modern and pythonic API asynchronously built on top of aiohttp
  • Flexible and easy to use
  • Statically typed with mypy
  • Linted with ruff
  • Well documented
  • Optimized for speed and performance
  • Automatically caches data for faster access
  • Caches endpoints for user convenience

Installation

$ python -m pip install PokeLance

Usage

import asyncio

from pokelance import PokeLance

client = PokeLance()  # Create a client instance


async def main() -> None:
    print(await client.ping())  # Ping the pokeapi
    print(await client.berry.fetch_berry("cheri"))  # Fetch a berry from the pokeapi
    print(await client.berry.fetch_berry_flavor("spicy"))
    print(await client.berry.fetch_berry_firmness("very-soft"))
    print(client.berry.get_berry("cheri"))  # Get a cached berry it will return None if it doesn't exist
    print(client.berry.get_berry_flavor("spicy"))
    print(client.berry.get_berry_firmness("very-soft"))
    await client.close()  # Close the client
    return None


asyncio.run(main())

With Async Context Manager

import asyncio

import aiohttp
from pokelance import PokeLance


async def main() -> None:
    # Use an async context manager to create a client instance
    async with aiohttp.ClientSession() as session, PokeLance(session=session) as client:
        print(await client.ping())  # Ping the pokeapi
        print(await client.berry.fetch_berry("cheri"))  # Fetch a berry from the pokeapi
        print(await client.berry.fetch_berry_flavor("spicy"))
        print(await client.berry.fetch_berry_firmness("very-soft"))
        print(client.berry.get_berry("cheri"))  # Get a cached berry it will return None if it doesn't exist
        print(client.berry.get_berry_flavor("spicy"))
        print(client.berry.get_berry_firmness("very-soft"))
        # The client will be closed automatically when the async context manager exits
    return None

asyncio.run(main())

Examples

Examples

Following examples are available open an issue if you want more examples or more details on certain examples.

  • Basic Usage
  • Advanced cache usage
  • Discord bot example
  • FastAPI example

Important Links

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

pokelance-0.2.3.tar.gz (52.0 kB view details)

Uploaded Source

Built Distribution

pokelance-0.2.3-py3-none-any.whl (74.9 kB view details)

Uploaded Python 3

File details

Details for the file pokelance-0.2.3.tar.gz.

File metadata

  • Download URL: pokelance-0.2.3.tar.gz
  • Upload date:
  • Size: 52.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/6.2.0-1018-azure

File hashes

Hashes for pokelance-0.2.3.tar.gz
Algorithm Hash digest
SHA256 f9f54bdef3ab36441ea216cbd70bfda35fc1583f1b3ce64e0f276931b98c362a
MD5 269460fa3d6377ec1b395bb455b7c66f
BLAKE2b-256 7bd66d57104221d8f1df22a12372f478982d1c4e0439c3adc2acf1fe8f367eec

See more details on using hashes here.

File details

Details for the file pokelance-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: pokelance-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 74.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/6.2.0-1018-azure

File hashes

Hashes for pokelance-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 150b232c6c3bdbb6608a03c4d1625cdb90c42ad9941c1fc26f5ac0c5f2a5aa10
MD5 fd62034955a239b4b86ab67a60739314
BLAKE2b-256 1e65d7c321a0cee333044ec56600f853ba7c73e27a94affffb7a44f0a10e1395

See more details on using hashes here.

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