Skip to content

0.8.0b1

Latest
Compare
Choose a tag to compare
@Jackenmen Jackenmen released this 03 Nov 00:38
c67c93e

First beta release!

This release adds coverage for all of the API's endpoints along with a bunch of refactoring around the bulk endpoint.

Breaking changes:

  • The old Client.get_player() method has been split:
    • Client.get_player(player_id) (i.e. with no platform) is now fulfilled by Client.find_player(player_id)
    • Client.get_player(player_id, platform) (where platform is not None) is now fulfilled by 2 new methods:
      • Client.get_player_by_id(platform, user_id) for lookups by ID (all platforms except for Nintendo Switch support this now)
      • Client.get_player_by_name(platform, user_name) for lookups by user name (all platforms support this, consult Platform Player IDs docs for limitations)
    • Additionally, there's now a new method (Client.get_players()) for looking up multiple players at once
  • Player.player_id has been removed
    • This field used to contain the unchanged input passed to Client.get_player() but this is not really part of the API model and cannot be filled when using the bulk endpoint

Features:

  • Added a few useful constants to the library: RANKS, DIVISIONS, SEASON_REWARDS, PLAYLISTS_WITH_SEASON_REWARDS
  • Added Client.get_player_by_id(), Client.get_player_by_name(), and Client.find_player() to replace the removed Client.get_player()
  • Added Client.get_players() that allows to query multiple player profiles on a single platform at once
  • Player now includes a stats attribute with player stats (assists, goals, MVPs, etc.)
  • Added Client.get_population() that allows to query population across different platforms and playlists
  • Added Client.get_skill_leaderboard() that allows to query skill leaderboard for the playlist on the given platform
  • Added Client.get_stat_leaderboard() that allows to query leaderboard for the specified stat on the given platform
  • Added Client.get_player_titles() and Player.titles() that allow to query the API for the list of player's titles

Enhancements:

  • Added new lifetime_matches_played and placement_matches_played attributes to Playlist instances
  • Added new TIER_MAX and DIVISION_MAX class constants to Playlist
  • Added new next_level attribute to SeasonRewards instances
  • Added new MAX_LEVEL class constant to SeasonRewards
  • Epic players can now be looked up by their display name
  • PlayStation and Xbox One players can now be looked up by IDs (provided that you can get it from somewhere)
  • Platform.ps4's friendly name is now "PlayStation" rather than "PlayStation 4"

Fixes:

  • Fixed collection of tier estimates for max tier in the rlapi.ext.tier_breakdown.rlstatsnet module
  • Fixed inaccurate regex for Nintendo Switch nicknames in Client.find_player() which determined whether the library tries to query the API for the given player ID on that platform

Docs:

  • Added Platform Player IDs docs listing the identifiers that can be used to lookup a player on each platform, along with the limitations of those lookup methods