Welcome to Brawl Stats' documentation!
======================================

.. image:: https://img.shields.io/pypi/v/brawlstats.svg
    :target: https://pypi.org/project/brawlstats/
    :alt: PyPi

.. image:: https://travis-ci.com/SharpBit/brawlstats.svg?branch=master
    :target: https://travis-ci.com/SharpBit/brawlstats
    :alt: Travis-CI build

.. image:: https://img.shields.io/github/license/SharpBit/brawlstats.svg
    :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
    :alt: MIT License

- This library is a sync and async wrapper for the Brawl Stars API.
- Python 3.5.3 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 maps and more!
- Get information about current available brawlers.

Installation
~~~~~~~~~~~~

Install the latest stable build:

::

   pip install brawlstats

.. toctree::
   :maxdepth: 3

   api
   exceptions
   logging

Indices
~~~~~~~

* :ref:`genindex`
* :ref:`search`