Skip to main content

Python wrapper for UnbelievaBoat API

Project description

UnbPy

logo

About UnbPy

UnbPy is a library providing a Python interface to the UnbelivaBoat API. To use it, you need to get a token from the official documentation page. Also supports discord.py Guild and User objects.

discord status release api documentation python

Help

You can find an in-depth tutorial and a detailed documentation on our wiki.

Quick Start

Setup

  1. Install UnbPy.
  2. Go to the UnbelivaBoat site.
  3. Login to your Discord account.
  4. Go to the API page.
  5. Click "Copy" under the big string of red text. Your token is now in the clipboard. example
>>> client = Client('Insert token here')
>>> guild = Guild(0) # Replace 0 with a Discord guild id
>>> user = User(0)   # Replace 0 with a Discord user id

Functions

client.get_balance(guild, user)

Returns: User with all attributes set.

client.get_leaderboard(guild)

Returns: list of Users with all attributes set, ordered by rank.

client.patch_balance(guild, user, cash, bank)

Returns: User with all attributes except rank set and an updated balance.

client.set_balance(guild, user, cash, bank)

Returns: User with all attributes except rank set and the new balance.

Dependencies

  • Python
  • aiohttp
  • discord.py (optional)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Pybelieva-0.0.1.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

Pybelieva-0.0.1-py3-none-any.whl (3.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page