brawlstats 4.2.0
BrawlStats is an easy-to-use sync and async Python API wrapperto fetch statistics from the official Brawl Stars API
License: MIT
Requires Python: >=3.9.0
Keywords: brawl stars, brawl stats, brawlstats, supercell, python, sync, async, python wrapper, api wrapper, python api wrapper, python 3.9, python 3.10, python 3.11, python 3.12

.. image:: https://i.imgur.com/5uUkTrn.png
    :alt: Brawl Stats

Brawl Stats
===========

.. image:: https://img.shields.io/pypi/v/brawlstats.svg
    :target: https://pypi.org/project/brawlstats/
    :alt: PyPi

.. image:: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml
    :alt: GitHub Actions Tests

.. image:: https://img.shields.io/pypi/pyversions/brawlstats.svg
    :target: https://pypi.org/project/brawlstats/
    :alt: Supported Versions

.. image:: https://img.shields.io/github/license/SharpBit/brawlstats.svg
    :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
    :alt: MIT License

.. image:: https://readthedocs.org/projects/brawlstats/badge/?version=stable
    :target: https://brawlstats.readthedocs.io/en/stable/?badge=stable
    :alt: 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
~~~~

- If you are currently using this wrapper, please star this repository :)
- If you come across an issue in the wrapper, please `create an issue`_.
- If you need an API key, visit https://developer.brawlstars.com

Contributing
~~~~~~~~~~~~
Special thanks to this project's contributors ❤️

- `erickang21`_
- `fourjr`_
- `golbu`_
- `kjkui`_
- `kyb3r`_
- `Papiersnipper`_
- `OrangutanGaming`_
- `Stitch`_

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.

.. _create an issue: https://github.com/SharpBit/brawlstats/issues
.. _Read the Docs: https://brawlstats.readthedocs.io/en/stable/
.. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples
.. _discord.py: https://github.com/rapptz/discord.py
.. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md

.. _erickang21: https://github.com/erickang21
.. _fourjr: https://github.com/fourjr
.. _OrangutanGaming: https://github.com/OrangutanGaming
.. _Stitch: https://github.com/Soumil07
.. _kjkui: https://github.com/kjkui
.. _kyb3r: https://github.com/kyb3r
.. _Papiersnipper: https://github.com/robinmahieu
.. _golbu: https://github.com/0dminnimda