unbelipy 2.1.0b0

Asynchronous wrapper for UnbelievaBoat's API written in Python.

unbelipy

Asynchronous wrapper for UnbelievaBoat's API written in Python.

Characteristics

• Easy to use
• Full error handling
• Type hinted readable code
• Active maintenance
• Fully Asynchronous

Note

This wrapper has not been declared to be official by the UnbelievaBoat developers. Any internal library issues/feature requests are to be directed here.

Project status

Early beta stage. It's not yet production ready.
Although most of the functionality is operational, rate limits are still being worked on.

Installation

Python 3.8 or above required, due to typehinting.

To install unbelipy from PyPI, use the following command:

pip install -U unbelipy

Or to install from Github:

pip install -U git+https://github.com/chrisdewa/unbelipy/

Dependencies

The following libraries will be needed and automatically installed with unbelipy:

• aiohttp - async requests
• aiolimiter - implementation of async rate limiter

Feature Requests

For feature requests, please open a Pull Request with detailed instructions.
Likewise, if you encounter any issues, you may create a new Issue.

Examples

from unbelipy import UnbeliClient

client = UnbeliClient(token='Unbelievaboats token generated from https://unbelievaboat.com/applications/')
guild_id: int = ...
member_id: int = ...

async def main():
    perms = await client.get_permissions(guild_id)
    guild = await client.get_guild(guild_id)
    guild_leaderboard = await client.get_guild_leaderboard(guild_id)
    user_balance = await client.get_user_balance(guild_id, member_id)
    user_balance = await client.edit_user_balance(guild_id, member_id, cash='5') # adds 5 to the user's cash
    user_balance = await client.set_user_balance(guild_id, member_id, cash='5') # sets the user's cash to 5

More examples!

Links

• Documentation

Contact

As of now, there is no support server for this library. However, you may contact the following people on Discord:

• ChrisDewa#4552
• invalid-user#1119