[go: up one dir, main page]

Skip to content

(A)sync Python API wrapper for the Brawl Stars API

License

Notifications You must be signed in to change notification settings

SharpBit/brawlstats

Repository files navigation

Brawl Stats

Brawl Stats

PyPi GitHub Actions Tests Supported Versions MIT License Documentation Status
  • BrawlStats is a sync and async Python API wrapper to fetch statistics from the official Brawl Stars API.
  • Python 3.9 or later is required.

Features

  • Easy to use with an object oriented design.
  • Use the same client for sync and async usage.
  • Get a player profile and battlelog.
  • Get a club and its members.
  • Get the top 200 rankings for players, clubs, or a specific brawler.
  • Get information about all the brawlers in the game.
  • Get information about the current event rotation!

Installation

Install the latest stable build:

pip install brawlstats

Install the development build:

pip install git+https://github.com/SharpBit/brawlstats@development

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

Misc

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. This project is no longer actively maintained. No new features will be added, only bugfixes and security fixes will be accepted.