Asynchronous wrapper for UnbelievaBoat's API written in python
Project description
unbelipy
Asynchronous wrapper for UnbelievaBoat's API written in python
Characteristics
- Easy to use
- Full error handling
- Type hinted and readable code
Project status
Early alpha and as such unsuitable for production.
Installation
pip install unbelipy
Use:
from unbelipy import UnbeliClient
import asyncio
TOKEN = "Token generated through Unbelievaboat's portal"
client = UnbeliClient(token=TOKEN)
async def main():
# get guild information
guild_info = await client.get_guild(guild_id=305129477627969547)
print(guild_info)
# get guild leaderboard
guild_leaderboard = await client.get_leaderboard(guild_id=305129477627969547)
print(guild_leaderboard)
# get user balance
balance = await client.get_balance(guild_id=305129477627969547, member_id=80821761460928512)
print(balance)
# put balance (set to x amount)
balance = await client.set_balance(guild_id=305129477627969547,
member_id=80821761460928512,
cash=1000,
reason="Showing off put method")
# patch balance (increment or decrement by x amount)
balance = await client.edit_balance(guild_id=305129477627969547,
member_id=80821761460928512,
cash=-500,
reason="Showing off patch method")
print(balance)
asyncio.run(main())
"balance" is a returned Dataclass with balance information containing:
- total: total amount of currency (cash + bank)
- bank: amount in bank
- cash: amount in cash
- user_id: id of the user for which the amount is set
- guild_id: id for the guild the user belongs to
- rank: rank of the user in the guild according to query parameters
"guild_info" is a dataclass with guild info containing:
- id
- name
- icon
- owner_id
- member_count
- symbol (currency)
UnbeliClient also has a rate_limit_data attribute with information returned with each request from the API.
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
unbelipy-0.0.5a0.tar.gz
(6.3 kB
view hashes)
Built Distribution
Close
Hashes for unbelipy-0.0.5a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e6baeaa5c1918b958b360799dca0c7f70888f9133f088cb2def3650f097a2f9 |
|
MD5 | 550e41b1f2a4728b4d0d7ee712b65731 |
|
BLAKE2b-256 | 120cd6dd8bdf2d6f64b79175136456eec81a6c4f9fa27948b52ddc1522438c75 |