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.1a0.tar.gz
(43.7 kB
view details)
Built Distribution
File details
Details for the file pokelance-0.0.1a0.tar.gz
.
File metadata
- Download URL: pokelance-0.0.1a0.tar.gz
- Upload date:
- Size: 43.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.8 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16d6942b754bd43e04964015b309cd4899189d11a53c153cc12d6cbf74466295 |
|
MD5 | 6783b37767c91b6ef952101c0bde382b |
|
BLAKE2b-256 | 0ab278d1c8789c326cacab16893e7419977865c88c027e1e25af28220d363e15 |
File details
Details for the file pokelance-0.0.1a0-py3-none-any.whl
.
File metadata
- Download URL: pokelance-0.0.1a0-py3-none-any.whl
- Upload date:
- Size: 66.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.8 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 154e58f15bc7b48f118f9f96ddf4cc1f999f08f79a0302bb5e45e34b2f3634d1 |
|
MD5 | 60ca7644ac68db658cc2b5f4b5f37ea2 |
|
BLAKE2b-256 | ebfcbd352233c7246cc9fd1aff80b09564b3ac7a5dfe4f0220f229d6985fd542 |