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.
To keep up with API changes, discussions, and status, I recommend you join the API’s 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, create one using the dashboard.

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.10.tar.gz (219.8 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for brawlstats-2.3.10.tar.gz
Algorithm Hash digest
SHA256 7b8002a2d78284d2a0a7433903dd224c3ff6a8b4abbb939936da07e8e63dd7b3
MD5 e81bde40c8efa17499d711e3a7e087c5
BLAKE2b-256 72edd2d472af64f9af768868eb3249ed1a956d4c4d71e7645aa0a0893cc4d58f

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