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.1.0.tar.gz
(49.8 kB
view details)
Built Distribution
pokelance-0.1.0-py3-none-any.whl
(72.6 kB
view details)
File details
Details for the file pokelance-0.1.0.tar.gz
.
File metadata
- Download URL: pokelance-0.1.0.tar.gz
- Upload date:
- Size: 49.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Linux/5.15.0-1035-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11bbf1e5f75729a723916abe98c85a0113bb53bf1630ac8f7289b4ebf84ac329 |
|
MD5 | 705e47bad3812a8c5ffc9d35f2d76836 |
|
BLAKE2b-256 | 46811dc9ef1eb474896ff026f84ae6da4ccef9b16d74527f63ec840a5e2b647b |
File details
Details for the file pokelance-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: pokelance-0.1.0-py3-none-any.whl
- Upload date:
- Size: 72.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Linux/5.15.0-1035-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad83904500bfdae52ae990fee8ac3fc7551b43ebe83f2f3f3c7a81aa00f028e9 |
|
MD5 | 6822325a4aca6bce63239d90bc694961 |
|
BLAKE2b-256 | f319fbea908df0d22952ba161de12e1811fda309dd08603b6c9a1a94aa64b706 |