Metadata-Version: 2.4
Name: bswrapper
Version: 0.2.2
Summary: An easy to use API Wrapper for the Brawl Stars API
Author-email: BigPattyOG <ptfaint@gmail.com>
License-Expression: MIT
Project-URL: Repository, https://github.com/BigPattyOG/bswrapper
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: license-file

# Brawl Stars Wrapper (BSWrapper) - v0.2.2

## What is BSWrapper?

BSWrapper is a user friendly API wraper for the [Brawl Stars API](https://developer.brawlstars.com). It aims to make pulling all information found in the API as easy as possibly without needing to use a 3rd party API.

## Requirements

- Python 3.12 or higher

## How do I install it?

To install BSWrapper, simply run:

```bash
pip install bswrapper
```
or in your requirements.txt, enter it as:
```txt
bswrapper>=0.2.2
```

## How to use BSWrapper

### Example 1: Player Data:

```py
from bswrapper import BSClient

bs = BSClient("API_TOKEN")

player = bs.get_player("#TAG")

print(player.name)
print(player.tag)
print(player.trophies) # current trophies
print(player.club.name) # if they are in a club, if not it just shows 'None'
print(player.club.tag) # if they are in a club, if not it just shows 'None'
print(player.highest) # highest trophies
print(player.explevel)
print(player.solo) # amount of solo victories

# NOTE: this is all of properties so far in the wrapper
```

### Example 2: Club Data:

```py
from bswrapper import BSClient

bs = BSClient("API_TOKEN")

club = bs.get_club("#TAG")

print(club.name)
print(club.tag)
print(club.trophies) # total trophies
print(club.required) # required trophies
print(club.type) # this will print either: open, inviteOnly, closed, unknown
print(club.description) # the club description/bio seen in the game

# NOTE: this is all of properties so far in the wrapper
```


