Merge pull request #62 from 0dminnimda/issue_60_making_get_brawlers

Issue 60 making get brawlers

Author: SharpBit

CHANGELOG.md

@@ -1,6 +1,19 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+
+## [Unnoun yet] - 6/27/20
+### Added
+- `get_brawlers` function to get available brawlers
+### Changed
+- splitting `BaseBox` into `BaseBox` and `BaseBoxList` for convenience
+### Fixed
+- tox for py38 works (not completely sure)
+
+## [4.0.3] - 4/17/20
+### Fixed
+- Brawler leaderboards for Python 3.5
+
 ## [4.0.2] - 4/15/20
 ### Fixed
 - Player model bug

brawlstats/__init__.py

@@ -8,7 +8,7 @@
 ############
 
 
-__version__ = 'v4.0.2'
+__version__ = 'v4.0.3'
 __title__ = 'brawlstats'
 __license__ = 'MIT'
 __author__ = 'SharpBit'

brawlstats/core.py

@@ -9,7 +9,7 @@
 from cachetools import TTLCache
 
 from .errors import Forbidden, NotFoundError, RateLimitError, ServerError, UnexpectedError
-from .models import BattleLog, Club, Constants, Members, Player, Ranking
+from .models import BattleLog, Brawlers, Club, Constants, Members, Player, Ranking
 from .utils import API, bstag, typecasted
 
 log = logging.getLogger(__name__)
@@ -310,3 +310,13 @@ def get_constants(self, key=None):
         Returns Constants
         """
         return self._get_model(self.api.CONSTANTS, model=Constants, key=key)
+
+    def get_brawlers(self):
+        """
+        Get available brawlers and information about them.
+
+        No parameters
+
+        Returns Brawlers
+        """
+        return self._get_model(self.api.BRAWLERS_URL, model=Brawlers)

brawlstats/models.py

@@ -2,7 +2,8 @@
 from .utils import bstag
 
 
-__all__ = ['Player', 'Club', 'Members', 'Ranking', 'BattleLog', 'Constants']
+__all__ = ['Player', 'Club', 'Members', 'Ranking', 'BattleLog', 'Constants', 'Brawlers']
+
 
 class BaseBox:
     def __init__(self, client, data):
@@ -11,14 +12,7 @@ def __init__(self, client, data):
 
     def from_data(self, data):
         self.raw_data = data
-        if isinstance(data, list):
-            self._boxed_data = BoxList(
-                data, camel_killer_box=True
-            )
-        else:
-            self._boxed_data = Box(
-                data, camel_killer_box=True
-            )
+        self._boxed_data = Box(data, camel_killer_box=True)
         return self
 
     def __getattr__(self, attr):
@@ -37,6 +31,17 @@ def __getitem__(self, item):
             raise IndexError('No such index: {}'.format(item))
 
 
+class BaseBoxList(BaseBox):
+    def from_data(self, data):
+        data = data['items']
+        self.raw_data = data
+        self._boxed_data = BoxList(data, camel_killer_box=True)
+        return self
+
+    def __len__(self):
+        return sum(1 for i in self)
+
+
 class Player(BaseBox):
     """
     Returns a full player object with all of its attributes.
@@ -85,47 +90,45 @@ def get_members(self):
         return self.client._get_model(url, model=Members)
 
 
-class Members(BaseBox):
+class Members(BaseBoxList):
     """
     Returns the members in a club.
     """
 
-    def __init__(self, client, data):
-        super().__init__(client, data['items'])
-
-    def __len__(self):
-        return sum(1 for i in self)
-
     def __repr__(self):
         return '<Members object count={}>'.format(len(self))
 
 
-class Ranking(BaseBox):
+class Ranking(BaseBoxList):
     """
     Returns a player or club ranking that contains a list of players or clubs.
     """
 
-    def __init__(self, client, data):
-        super().__init__(client, data['items'])
-
-    def __len__(self):
-        return sum(1 for i in self)
-
     def __repr__(self):
         return '<Ranking object count={}>'.format(len(self))
 
 
-class BattleLog(BaseBox):
+class BattleLog(BaseBoxList):
     """
     Returns a full player battle object with all of its attributes.
     """
-
-    def __init__(self, client, data):
-        super().__init__(client, data['items'])
+    pass
 
 
 class Constants(BaseBox):
     """
     Returns some Brawl Stars constants.
     """
     pass
+
+
+class Brawlers(BaseBoxList):
+    """
+    Returns list of available brawlers and information about them.
+    """
+
+    def __repr__(self):
+        return '<Brawlers object count={}>'.format(len(self))
+
+    def __str__(self):
+        return 'Here {} brawlers'.format(len(self))

brawlstats/utils.py

@@ -16,6 +16,7 @@ def __init__(self, base_url, version=1):
         self.CLUB = self.BASE + '/clubs'
         self.RANKINGS = self.BASE + '/rankings'
         self.CONSTANTS = 'https://fourjr.herokuapp.com/bs/constants'
+        self.BRAWLERS_URL = self.BASE + "/brawlers"
 
         # Get package version from __init__.py
         path = os.path.dirname(__file__)
@@ -55,6 +56,7 @@ def bstag(tag):
 
     return tag
 
+
 def get_datetime(timestamp: str, unix=True):
     """
     Converts a %Y%m%dT%H%M%S.%fZ to a UNIX timestamp
@@ -76,6 +78,12 @@ def get_datetime(timestamp: str, unix=True):
     else:
         return time
 
+
+# do nothing
+def nothing(value):
+    return value
+
+
 def typecasted(func):
     """Decorator that converts arguments via annotations.
     Source: https://github.com/cgrok/clashroyale/blob/master/clashroyale/official_api/utils.py#L11"""
@@ -89,7 +97,7 @@ def wrapper(*args, **kwargs):
         for _, param in signature:
             converter = param.annotation
             if converter is inspect._empty:
-                converter = lambda a: a  # do nothing
+                converter = nothing
             if param.kind is param.POSITIONAL_OR_KEYWORD:
                 if args:
                     to_conv = args.pop(0)

docs/api.rst

@@ -25,6 +25,9 @@ Data Models
 .. autoclass:: brawlstats.models.Constants
     :members:
 
+.. autoclass:: brawlstats.models.Brawlers
+    :members:
+
 
 Attributes of Data Models
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -264,3 +267,16 @@ Attributes:
             ]
         }
     }
+
+Brawlers
+~~~~~~~~
+
+Returns list of available brawlers and information about them with this structure:
+
+Attributes:
+
+::
+
+[
+    Brawler
+]

docs/index.rst

@@ -24,7 +24,8 @@ Features
 - 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, brawlers, and more!
+- Get information about maps and more!
+- Get information about current available brawlers.
 
 Installation
 ~~~~~~~~~~~~

examples/async.py

@@ -1,27 +1,29 @@
 import brawlstats
 import asyncio
 
+# Do not post your token on a public github!
 client = brawlstats.Client('token', is_async=True)
-# Do not post your token on a public github
+
 
 # await only works in an async loop
 async def main():
     player = await client.get_profile('GGJVJLU2')
     print(player.trophies)  # access attributes using dot.notation
-    print(player.solo_victories)  # access using snake_case instead of camelCase
+    print(player.solo_victories)  # use snake_case instead of camelCase
 
     club = await player.get_club()
     print(club.tag)
-    members = await club.get_members()
-    best_players = members[:5]  # members sorted by trophies, gets best 5 players
+    members = await club.get_members()  # members sorted by trophies
+    best_players = members[:5]  # gets best 5 players
     for player in best_players:
         print(player.name, player.trophies)
 
-    ranking = await client.get_rankings(ranking='players', limit=5)  # gets top 5 players
+    # get top 5 players in the world
+    ranking = await client.get_rankings(ranking='players', limit=5)
     for player in ranking:
         print(player.name, player.rank)
 
-    # Get top 5 mortis players in the US
+    # get top 5 mortis players in the US
     ranking = await client.get_rankings(
         ranking='brawlers',
         region='us',

examples/discord_cog.py

@@ -2,6 +2,7 @@
 from discord.ext import commands
 import brawlstats
 
+
 class BrawlStars(commands.Cog, name='Brawl Stars'):
     """A simple cog for Brawl Stars commands using discord.py"""
 
@@ -17,6 +18,7 @@ async def profile(self, ctx, tag: str):
         except brawlstats.RequestError as e:  # catches all exceptions
             return await ctx.send('```\n{}: {}\n```'.format(e.code, e.message))  # sends code and error message
         em = discord.Embed(title='{0.name} ({0.tag})'.format(player))
+
         em.description = 'Trophies: {}'.format(player.trophies)  # you could make this better by using embed fields
         await ctx.send(embed=em)
 

examples/sync.py

@@ -1,23 +1,26 @@
 import brawlstats
 
+# Do not post your token on a public github!
 client = brawlstats.Client('token')
-# Do not post your token on a public github
+
 
 player = client.get_profile('GGJVJLU2')
 print(player.trophies)  # access attributes using dot.notation
-print(player.solo_victories)  # access using snake_case instead of camelCase
+print(player.solo_victories)  # use snake_case instead of camelCase
 
 club = player.get_club()
 print(club.tag)
-best_players = club.get_members()[:5]  # members sorted by trophies, gets best 5 players
+members = club.get_members()  # members sorted by trophies
+best_players = members[:5]  # gets best 5 players
 for player in best_players:
     print(player.name, player.trophies)  # prints name and trophies
 
-ranking = client.get_rankings(ranking='players', limit=5)  # gets top 5 players
+# gets top 5 players in the world
+ranking = client.get_rankings(ranking='players', limit=5)
 for player in ranking:
     print(player.name, player.rank)
 
-# Get top 5 mortis players in the US
+# get top 5 mortis players in the US
 ranking = client.get_rankings(
     ranking='brawlers',
     region='us',