# UnbelievaBoat API Python Wrapper
[](https://dc.yoggies.dev/)
[](https://www.python.org/downloads/release/python-380/)
[](https://pypi.org/project/unbelievaboat/)
[](https://pypi.org/project/unbelievaboat/)
This is a Python wrapper for the UnbelievaBoat API, which provides access to the UnbelievaBoat Discord bot functionality. It allows you to interact with the API endpoints to retrieve guild information, user balances, leaderboard data, and more.
## Installation
You can install the UnbelievaBoat API Python wrapper using pip. Open your terminal and run the following command:
```shell
pip install unbelievaboat
```
## Usage
Here's an example of how to use the UnbelievaBoat API Python wrapper to interact with the UnbelievaBoat API:
```python
from unbelievaboat import Client
import asyncio
async def main() -> None:
# Initialize the client with your API token
client = Client("your-api-token")
guild_id = ...
user_id = ...
# Retrieve guild information
guild = await client.get_guild(guild_id)
print(guild)
# Retrieve user balance
user = await guild.get_user_balance(user_id)
print(user)
# Set or update user balance
await user.set(bank=100)
await user.update(bank=-100)
print(user)
# Close the client session
await client.close()
# You can also use async context manager
async with Client("your-api-token") as client:
leaderboard = await client.get_guild_leaderboard(guild_id)
print(leaderboard)
asyncio.run(main())
```
Replace `"your-api-token"` with your actual API token. You can obtain an API token by logging into the UnbelievaBoat dashboard and generating a token for your bot.
Please note that the above example demonstrates a basic usage scenario. You can explore other available methods in the `Client` class to interact with different API endpoints. You can also find more examples in the [examples](https://github.com/yoggys/unbelievaboat/tree/main/examples) directory. For more information about the UnbelievaBoat API (data/params), please refer to the [official documentation](https://unbelievaboat-api.readme.io/reference/).
## Requirements
- Python 3.8+
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the [GitHub repository](https://github.com/yoggys/unbelievaboat).
## License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
Raw data
{
"_id": null,
"home_page": "https://github.com/yoggys/unbelievaboat",
"name": "unbelievaboat",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, unb, unbelievaboat, api, wrapper, async, asyncio",
"author": "yoggys",
"author_email": "yoggies@yoggies.dev",
"download_url": "https://files.pythonhosted.org/packages/bd/69/6f00518620f7ba7a93a1028bac882b3c824d11abab4c75f5d5ba0255d638/unbelievaboat-2.1.2.tar.gz",
"platform": null,
"description": "# UnbelievaBoat API Python Wrapper\r\n\r\n[](https://dc.yoggies.dev/)\r\n[](https://www.python.org/downloads/release/python-380/)\r\n[](https://pypi.org/project/unbelievaboat/)\r\n[](https://pypi.org/project/unbelievaboat/)\r\n\r\nThis is a Python wrapper for the UnbelievaBoat API, which provides access to the UnbelievaBoat Discord bot functionality. It allows you to interact with the API endpoints to retrieve guild information, user balances, leaderboard data, and more.\r\n\r\n## Installation\r\n\r\nYou can install the UnbelievaBoat API Python wrapper using pip. Open your terminal and run the following command:\r\n\r\n```shell\r\npip install unbelievaboat\r\n```\r\n\r\n## Usage\r\n\r\nHere's an example of how to use the UnbelievaBoat API Python wrapper to interact with the UnbelievaBoat API:\r\n\r\n```python\r\nfrom unbelievaboat import Client\r\nimport asyncio\r\n\r\n\r\nasync def main() -> None:\r\n # Initialize the client with your API token\r\n client = Client(\"your-api-token\")\r\n \r\n guild_id = ...\r\n user_id = ...\r\n\r\n # Retrieve guild information\r\n guild = await client.get_guild(guild_id)\r\n print(guild)\r\n\r\n # Retrieve user balance\r\n user = await guild.get_user_balance(user_id)\r\n print(user)\r\n \r\n # Set or update user balance\r\n await user.set(bank=100)\r\n await user.update(bank=-100)\r\n print(user)\r\n\r\n # Close the client session\r\n await client.close()\r\n \r\n # You can also use async context manager\r\n async with Client(\"your-api-token\") as client:\r\n leaderboard = await client.get_guild_leaderboard(guild_id)\r\n print(leaderboard)\r\n \r\n \r\nasyncio.run(main())\r\n```\r\n\r\nReplace `\"your-api-token\"` with your actual API token. You can obtain an API token by logging into the UnbelievaBoat dashboard and generating a token for your bot.\r\n\r\nPlease note that the above example demonstrates a basic usage scenario. You can explore other available methods in the `Client` class to interact with different API endpoints. You can also find more examples in the [examples](https://github.com/yoggys/unbelievaboat/tree/main/examples) directory. For more information about the UnbelievaBoat API (data/params), please refer to the [official documentation](https://unbelievaboat-api.readme.io/reference/).\r\n\r\n## Requirements\r\n\r\n- Python 3.8+\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the [GitHub repository](https://github.com/yoggys/unbelievaboat).\r\n\r\n## License\r\n\r\nThis project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Wrapper for UnbelievaBoat API.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/yoggys/unbelievaboat"
},
"split_keywords": [
"python",
" unb",
" unbelievaboat",
" api",
" wrapper",
" async",
" asyncio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f50a1c297280569377d88fff448c8eefcd9132466a349810c17b542aa30e2773",
"md5": "db50e07e504a2712d3fdc795b757c93e",
"sha256": "bd5a904ed36cdd5a0bc27f8c6ab011afe28fa1d1365a995bed16584383a30e6b"
},
"downloads": -1,
"filename": "unbelievaboat-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db50e07e504a2712d3fdc795b757c93e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21261,
"upload_time": "2024-10-16T23:35:20",
"upload_time_iso_8601": "2024-10-16T23:35:20.070345Z",
"url": "https://files.pythonhosted.org/packages/f5/0a/1c297280569377d88fff448c8eefcd9132466a349810c17b542aa30e2773/unbelievaboat-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd696f00518620f7ba7a93a1028bac882b3c824d11abab4c75f5d5ba0255d638",
"md5": "9b74ee75429c1fb2d1ec4b8b26c197f3",
"sha256": "3a92d09c73ab2c360674a46a72418fb5c71c857728c809efee1d2fced78c13e8"
},
"downloads": -1,
"filename": "unbelievaboat-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9b74ee75429c1fb2d1ec4b8b26c197f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14195,
"upload_time": "2024-10-16T23:35:21",
"upload_time_iso_8601": "2024-10-16T23:35:21.431794Z",
"url": "https://files.pythonhosted.org/packages/bd/69/6f00518620f7ba7a93a1028bac882b3c824d11abab4c75f5d5ba0255d638/unbelievaboat-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 23:35:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yoggys",
"github_project": "unbelievaboat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "unbelievaboat"
}
JSON
