Skip to main content

A flexible and easy to use pokemon library.

Project description

PokeLance

logo

license black mypy ruff stars 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())

Important Links


!!! note "Note" This is a work in progress. If you find any bugs or have any suggestions, please open an issue here.


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.0.5a0.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

pokelance-0.0.5a0-py3-none-any.whl (73.2 kB view details)

Uploaded Python 3

File details

Details for the file pokelance-0.0.5a0.tar.gz.

File metadata

  • Download URL: pokelance-0.0.5a0.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.8 Windows/10

File hashes

Hashes for pokelance-0.0.5a0.tar.gz
Algorithm Hash digest
SHA256 7e1358f800a273b22ad5147dd9369b0af9735375368c2df9a9e4b0d9ae060155
MD5 ef17d93dc7422df04090bc2fb6eae3be
BLAKE2b-256 17e6febf71e52aeed894c097b0e01f602e8b27c7098945a72d92d10b9fae117c

See more details on using hashes here.

File details

Details for the file pokelance-0.0.5a0-py3-none-any.whl.

File metadata

  • Download URL: pokelance-0.0.5a0-py3-none-any.whl
  • Upload date:
  • Size: 73.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.8 Windows/10

File hashes

Hashes for pokelance-0.0.5a0-py3-none-any.whl
Algorithm Hash digest
SHA256 95077276993aa2e5e11a628eb7f09157f6ca21b89f7ef0fa290144656ffc6b99
MD5 6b6598156462ba5451af8b8742bdffe0
BLAKE2b-256 ae0fa1713ed9ecd929c87259fe802a46d3267280893a87a9a47900fb8e1cdfdb

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