A flexible and easy to use pokemon library.
Project description
PokeLance
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
- PokeAPI
- PokeAPI Documentation
- PokeLance Documentation
- PokeLance ReadTheDocs
- PokeLance GitHub
- PokeLance PyPI
- PokeLance Discord
!!! note "Note" This is a work in progress. If you find any bugs or have any suggestions, please open an issue here.
Project details
Release history Release notifications | RSS feed
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.22a0.tar.gz
(48.5 kB
view details)
Built Distribution
File details
Details for the file pokelance-0.0.22a0.tar.gz
.
File metadata
- Download URL: pokelance-0.0.22a0.tar.gz
- Upload date:
- Size: 48.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.2 Linux/5.15.0-1034-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 881cc300ee64a2c009e72282606c1abe7b127c3333eed9ca279d289753a9e4bc |
|
MD5 | f14de37972bf949357ffe56b27edb58e |
|
BLAKE2b-256 | d3db21ec9c76c8897d38bceda54a109e3df24d031537dfe069ee86e244b565d5 |
File details
Details for the file pokelance-0.0.22a0-py3-none-any.whl
.
File metadata
- Download URL: pokelance-0.0.22a0-py3-none-any.whl
- Upload date:
- Size: 71.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.2 Linux/5.15.0-1034-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a138f366f1367eb0b4ce7c2aa6aae3cf2e3e603ac14356a4bb225348d2b140c9 |
|
MD5 | a2126d9b9718752254878de1ff632455 |
|
BLAKE2b-256 | 19f62826c3369fb5faf96bd713ef58ebdebbb3835bb3dafa1eaab5bbdeae4a42 |