Decorated all methods that required a Steam Web API Key with @api_key_required. Changed common/* 'base' classes to be prefixed by an _, to indicate their private use. Added multiple comments. Found out the tf2_beta game has been deprecated. Since we are unaware if this will continue to be deprecated, we placed a DeprecationWarning on the module.

Author: Michael Barr

steamwebapi/auth.py

@@ -3,7 +3,7 @@
 # =============================================================================
 # API Imports
 from .core import SteamWebAPI
-from .util.decorators import public
+from .util.decorators import public, api_key_required
 
 
 # =============================================================================
@@ -13,6 +13,7 @@
 class ISteamUserAuth(SteamWebAPI):
     """Methods relating to games' store's assets."""
 
+    @api_key_required
     def AuthenticateUser(self, steamid, sessionkey, encrypted_loginkey,
                          method_version=1):
         """
@@ -50,6 +51,7 @@ def AuthenticateUser(self, steamid, sessionkey, encrypted_loginkey,
 class ISteamWebUserPresenceOAuth(SteamWebAPI):
     """Methods relating to games' store's assets."""
 
+    @api_key_required
     def PollStatus(self, steamid, umqid, message, pollid='', sectimeout='',
                    secidletime='', use_accountids=False, method_version=1):
         """

steamwebapi/games/common/gameclient.py

@@ -17,8 +17,8 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class BaseIGCVersion(SteamWebAPI):
-    """Base class for IGCVersion_###."""
+class _BaseIGCVersion(SteamWebAPI):
+    """Base class for _IGCVersion_###."""
 
     def GetClientVersion(self, method_version=1):
         """.. function:: GetClientVersion(method_version=1)
@@ -65,8 +65,8 @@ def GetServerVersion(self, method_version=1):
         )
 
 
-class IGCVersion(BaseIGCVersion):
-    """Extends BaseIGCVersion adding methods not shared by all interfaces."""
+class _IGCVersion(_BaseIGCVersion):
+    """Extends _BaseIGCVersion adding methods not shared by all interfaces."""
 
     def GetClusterVersion(self, method_version=1):
         """.. function:: GetClusterVersion(method_version=1)

steamwebapi/games/common/items.py

@@ -10,14 +10,16 @@
 # >> IMPORTS
 # =============================================================================
 from ...core import SteamWebAPI
+from ...util.decorators import api_key_required
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class BaseITFPromos(SteamWebAPI):
+class _BaseITFPromos(SteamWebAPI):
     """Base class for ITFPromos_###."""
 
+    @api_key_required
     def GetItemID(self, steamid, promoid, method_version=1):
         """
         :param steamid: The method version to use.
@@ -37,6 +39,7 @@ def GetItemID(self, steamid, promoid, method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetItemID',
@@ -45,6 +48,7 @@ def GetItemID(self, steamid, promoid, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GrantItem(self, steamid, promoid, method_version=1):
         """"""
         # Set up the parameters
@@ -54,6 +58,7 @@ def GrantItem(self, steamid, promoid, method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GrantItem',
@@ -63,9 +68,10 @@ def GrantItem(self, steamid, promoid, method_version=1):
         )
 
 
-class BaseIEconItems(SteamWebAPI):
+class _BaseIEconItems(SteamWebAPI):
     """Base class for IEconItems_###."""
 
+    @api_key_required
     def GetPlayerItems(self, steamid, method_version=1):
         """"""
         # Set up the parameters
@@ -74,6 +80,7 @@ def GetPlayerItems(self, steamid, method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetPlayerItems',
@@ -82,6 +89,7 @@ def GetPlayerItems(self, steamid, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetSchema(self, language='', method_version=1):
         """"""
         # Set up the parameters
@@ -90,6 +98,7 @@ def GetSchema(self, language='', method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetSchema',
@@ -99,16 +108,18 @@ def GetSchema(self, language='', method_version=1):
         )
 
 
-class IEconItems(BaseIEconItems):
+class _IEconItems(_BaseIEconItems):
     """"""
 
+    @api_key_required
     def GetSchemaURL(self, method_version=1):
         """"""
         # Set up the parameters
         parameters = {
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetSchemaURL',
@@ -117,6 +128,7 @@ def GetSchemaURL(self, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetStoreMetaData(self, language='', method_version=1):
         """"""
         # Set up the parameters
@@ -125,6 +137,7 @@ def GetStoreMetaData(self, language='', method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetStoreMetaData',
@@ -134,9 +147,10 @@ def GetStoreMetaData(self, language='', method_version=1):
         )
 
 
-class ExtendedIEconItems(IEconItems):
+class _ExtendedIEconItems(_IEconItems):
     """"""
 
+    @api_key_required
     def GetStoreStatus(self, language='', method_version=1):
         """"""
         # Set up the parameters
@@ -145,6 +159,7 @@ def GetStoreStatus(self, language='', method_version=1):
             'key': self.key,
         }
 
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetStoreMetaData',
@@ -154,9 +169,10 @@ def GetStoreStatus(self, language='', method_version=1):
         )
 
 
-class BaseIEconDOTA2(SteamWebAPI):
+class _BaseIEconDOTA2(SteamWebAPI):
     """Base class for IEconDOTA2_###."""
 
+    @api_key_required
     def GetHeroes(self, itemizedonly, language='', method_version=1):
         """"""
         # Set up the parameters
@@ -166,7 +182,7 @@ def GetHeroes(self, itemizedonly, language='', method_version=1):
             'key': self.key,
         }
 
-        #
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetHeroes',
@@ -175,6 +191,7 @@ def GetHeroes(self, itemizedonly, language='', method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetRarities(self, language='', method_version=1):
         """"""
         # Set up the parameters
@@ -183,7 +200,7 @@ def GetRarities(self, language='', method_version=1):
             'key': self.key,
         }
 
-        #
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetRarities',
@@ -192,14 +209,15 @@ def GetRarities(self, language='', method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetTournamentPrizePool(self, method_version=1):
         """"""
         # Set up the parameters
         parameters = {
             'key': self.key,
         }
 
-        #
+        # Return the APIQuery
         return self.api_query(
             interface=self.__class__.__name__,
             method='GetTournamentPrizePool',

steamwebapi/games/common/leaderboards.py

@@ -16,8 +16,8 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class IPortal2Leaderboards(SteamWebAPI):
-    """Base class for IPortal2Leaderboards."""
+class _IPortal2Leaderboards(SteamWebAPI):
+    """Base class for _IPortal2Leaderboards."""
 
     def GetBucketizedData(self, leaderboardName, method_version=1):
         """"""

steamwebapi/games/common/match.py

@@ -11,14 +11,16 @@
 # =============================================================================
 # API Imports
 from ...core import SteamWebAPI
+from ...util.decorators import api_key_required
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class BaseIDOTA2Match(SteamWebAPI):
+class _BaseIDOTA2Match(SteamWebAPI):
     """Base class for IDOTA2Match_###."""
 
+    @api_key_required
     def GetLeagueListing(self, method_version=1):
         """"""
         # Set up the parameters
@@ -34,6 +36,7 @@ def GetLeagueListing(self, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetLiveLeagueGames(self, method_version=1):
         """"""
         # Set up the parameters
@@ -49,6 +52,7 @@ def GetLiveLeagueGames(self, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetMatchDetails(self, match_id, method_version=1):
         """"""
         # Set up the parameters
@@ -65,6 +69,7 @@ def GetMatchDetails(self, match_id, method_version=1):
             parameters=parameters,
         )
 
+    @api_key_required
     def GetMatchHistory(self, player_name=None, hero_id=None, game_mode=None,
                         skill=None, date_min=None, date_max=None,
                         min_players=None, account_id=None, league_id=None,
@@ -96,6 +101,7 @@ def GetMatchHistory(self, player_name=None, hero_id=None, game_mode=None,
             parameters=parameters,
         )
 
+    @api_key_required
     def GetMatchHistoryBySequenceNum(self, start_at_match_seq_num,
                                      matches_requested, method_version=1):
         """"""
@@ -114,6 +120,7 @@ def GetMatchHistoryBySequenceNum(self, start_at_match_seq_num,
             parameters=parameters,
         )
 
+    @api_key_required
     def GetTeamInfoByTeamID(self, start_at_team_id, teams_requested,
                             method_version=1):
         """"""

steamwebapi/games/csgo/gameclient.py

@@ -2,13 +2,13 @@
 # >> IMPORTS
 # =============================================================================
 # API Imports
-from ..common.gameclient import IGCVersion
+from ..common.gameclient import _IGCVersion
 from ...util.decorators import public
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
 @public
-class IGCVersion_730(IGCVersion):
+class IGCVersion_730(_IGCVersion):
     """Methods for retrieving CS:GO version information."""

steamwebapi/games/csgo/items.py

@@ -2,18 +2,18 @@
 # >> IMPORTS
 # =============================================================================
 # API Imports
-from ..common.items import BaseITFPromos, ExtendedIEconItems
+from ..common.items import _BaseITFPromos, _ExtendedIEconItems
 from ...util.decorators import public
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
 @public
-class ITFPromos_730(BaseITFPromos):
+class ITFPromos_730(_BaseITFPromos):
     """Methods for retrieving and granting promo items for CS:GO."""
 
 
 @public
-class IEconItems_730(ExtendedIEconItems):
+class IEconItems_730(_ExtendedIEconItems):
     """Methods relating to in-game items for CS:GO."""

steamwebapi/games/csgo_dev/gameclient.py

@@ -2,13 +2,13 @@
 # >> IMPORTS
 # =============================================================================
 # API Imports
-from ..common.gameclient import IGCVersion
+from ..common.gameclient import _IGCVersion
 from ...util.decorators import public
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
 @public
-class IGCVersion_570(IGCVersion):
+class IGCVersion_570(_IGCVersion):
     """Methods for retrieving DOTA2 version information."""

steamwebapi/games/csgo_dev/items.py

@@ -2,18 +2,18 @@
 # >> IMPORTS
 # =============================================================================
 # API Imports
-from ..common.items import BaseITFPromos, BaseIEconItems
+from ..common.items import _BaseITFPromos, _BaseIEconItems
 from ...util.decorators import public
 
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
 @public
-class ITFPromos_710(BaseITFPromos):
+class ITFPromos_710(_BaseITFPromos):
     """Methods for retrieving and granting promo items for CS:GO Dev."""
 
 
 @public
-class IEconItems_710(BaseIEconItems):
+class IEconItems_710(_BaseIEconItems):
     """Methods relating to in-game items for CS:GO Dev."""