An easy-to-use wrapper for the unofficial Brawl Stars API
Project description
Brawl Stats
This library is a sync and async wrapper for https://api.starlist.pro (BrawlAPI) and the official Brawl Stars API.
Python 3.5.3 or later is required.
Features
Covers all of the endpoints of both APIs.
Use the same client for sync and async usage.
Choose which API you want to use!
Access game constants such as maps, brawlers, and images.
Easy to use with an object oriented design.
Installation
Install the latest stable build:
pip install brawlstats
Install the development build:
pip install git+https://github.com/SharpBit/brawlstats
Documentation
Documentation is being hosted on Read the Docs.
Examples
Examples are in the examples folder. Within each folder, you will find:
sync.py shows you basic sync usage
async.py shows you basic async usage
discord_cog.py shows an example Discord Bot cog using discord.py
Misc
If you are currently using this wrapper, please star this repository :)
If you come across an issue in the wrapper, please create an issue. Do not PM me on Discord for help.
If you need an API Key for BrawlAPI, create one using the dashboard. If you need one for the official API, visit https://developer.brawlstars.com
To receive help for using the BrawlAPI, I recommend you join BrawlAPI’s discord server.
Contributing
Special thanks to this project’s contributors ❤️
If you want to contribute, whether it be a bug fix or new feature, make sure to follow the contributing guidelines.
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
File details
Details for the file brawlstats-3.0.4.tar.gz
.
File metadata
- Download URL: brawlstats-3.0.4.tar.gz
- Upload date:
- Size: 327.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 166173ccff7f845b77a1e6b1e106a24ea6d6884a1300226d07474fc2174373d8 |
|
MD5 | 26362371f06b64feb3f9e6b1a9e873a5 |
|
BLAKE2b-256 | c36f49943f6a491ff1bb8a49b8bf2d45a43dc847f59d893897c576b21dbf0643 |