A Python wrapper for the Wynncraft API
Project description
Corkus.py ⚙️
Asynchronous, feature-rich and easy to use Python wrapper for Public Wynncraft API.
Key Features
- Modern asynchronous API using
async
/await
syntax. - Easy to use with an object oriented design using
fetch
and helper functions. - 100% coverage of the Wynncraft API.
- Proper rate limit handling that prevents 429s.
- Responses caching to improve speed.
Installation
Python 3.8+ or higher is required
pip install corkus.py
Or install latest development version:
pip install --upgrade git+https://github.com/MrBartusek/corkus.py@main
See documentation for more information.
Quick Example
Using Context Manager:
import asyncio
from corkus import Corkus
async def player_stats():
async with Corkus() as corkus:
player = await corkus.player.get("Salted")
print(f"username: {player.username}")
print(f"chests_found: {player.statistics.chests_found}")
loop = asyncio.get_event_loop()
loop.run_until_complete(player_stats())
Without Context Manager:
import asyncio
from corkus import Corkus
async def player_stats():
corkus = Corkus()
player = await corkus.player.get("Salted")
print(f"username: {player.username}")
print(f"chests_found: {player.statistics.chests_found}")
await corkus.close()
loop = asyncio.get_event_loop()
loop.run_until_complete(player_stats())
Output:
username: Salted
chests_found: 219
Contributing
Want to contribute to the project?
First of all, thanks! Check contributing guidelines for more information.
Links
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
corkus.py-1.0.0.tar.gz
(42.6 kB
view hashes)
Built Distribution
corkus.py-1.0.0-py3-none-any.whl
(68.9 kB
view hashes)
Close
Hashes for corkus.py-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 385a49852ffb070af860dd348c5a2fb3afa1e8bdd2a4be9743ef526ce9a086fb |
|
MD5 | 76b463d083f25566207227dec98d753e |
|
BLAKE2b-256 | afcb6fae7c59d050a9822fb303c7a0fc820477594f0cba9ed0f6267f03d8be5c |