Skip to main content

An easy-to-use wrapper for the unofficial Brawl Stars API

Project description

Brawl Stats

Brawl Stats

PyPi Travis-CI build Supported Versions MIT License
This library is a sync and async wrapper the unofficial Brawl Stars API.
Please note that both this API and wrapper are both still in beta, so there will be frequent breaking changes.
To keep up with API changes, discussions, and status, I recommend you join the discord server.

Features

  • Covers all of the API endpoints.

  • Use the same client for sync and async usage.

  • Helper functions to access other game files such as maps and audio files.

  • 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.

  • 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 rewrite

Misc

If you are currently using this wrapper, feel free to 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, join the API’s discord server.

Contributing

If you want to contribute, whether it be a bug fix or new feature, make sure to follow the contributing guidelines.

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

brawlstats-2.3.0.tar.gz (197.1 kB view details)

Uploaded Source

File details

Details for the file brawlstats-2.3.0.tar.gz.

File metadata

  • Download URL: brawlstats-2.3.0.tar.gz
  • Upload date:
  • Size: 197.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for brawlstats-2.3.0.tar.gz
Algorithm Hash digest
SHA256 5de0d78963da3c079b59e2606646b8396d52c6f69c922e4856f8fd8efeb969a5
MD5 8d1213f085f45bec24ad70c6aebe12f3
BLAKE2b-256 39d6b5bf498ca5d07cfdb5861b57e93ca70ecfbd85be52b051e421a8d1ff0ae8

See more details on using hashes here.

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