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

Uploaded Source

Built Distribution

pokelance-0.0.2a0-py3-none-any.whl (70.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pokelance-0.0.2a0.tar.gz
  • Upload date:
  • Size: 47.7 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.2a0.tar.gz
Algorithm Hash digest
SHA256 ce883f5f2649a30a0cb0240ee3d1c76dc3d99a10389c304d1449875a3cb1438a
MD5 85dd1607c57f3229ed3302519f9289a8
BLAKE2b-256 858947da89995d8b419828fad702b7000a9eca098c85c6423148a148c23b7213

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pokelance-0.0.2a0-py3-none-any.whl
  • Upload date:
  • Size: 70.3 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.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a71440711ba2e3c077cb4dd16a727532246549787f75e00e08a48ce02107492
MD5 9d4b3b03506020f0a9f933cdba333357
BLAKE2b-256 831bab06179bf7d1a73573703c8de20965ca23990b70f8e688923274f83e847a

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