Merge branch 'dev', v0.5.1

9897c59 - WebAPI: fix set concatenation in python3
4aa9200 - version bump v0.5.1
8fd391c - fix setup.py install fail when missing dependecies
cbde28a - WebAPI: fix regression w/ required param check
f5d6bc8 - WebAPI: moved doc() to __doc__; doc() now prints

README.rst

@@ -38,7 +38,7 @@ The response will be deserialized using the appropriate module unless ``raw`` is
 
 .. code:: python
 
-    >>> print api.ISteamUser.ResolveVanityURL.doc()  # method doc
+    >>> api.ISteamUser.ResolveVanityURL.__doc__  # method doc
     """
     ResolveVanityURL (v0001)
 
@@ -51,8 +51,11 @@ The response will be deserialized using the appropriate module unless ``raw`` is
           - The vanity URL to get a SteamID for
 
     """
-    >>> print api.ISteamUser.doc()  # interface and all methods
-    >>> print api.doc()  # all available interfaces
+
+    # or calling doc() will print it
+    >>> api.ISteamUser.ResolveVanityURL.doc()  # method doc
+    >>> api.ISteamUser.doc()  # interface and all methods
+    >>> api.doc()  # all available interfaces
 
 
 Checkout the wiki for a `list of the currently available API interfaces`_.

setup.py

@@ -4,11 +4,12 @@ from setuptools import setup
 from codecs import open
 from os import path
 
-from steam import __version__
 
 here = path.abspath(path.dirname(__file__))
 with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
+with open(path.join(here, 'steam/__init__.py'), encoding='utf-8') as f:
+    __version__ = f.readline().split('"')[1]
 
 setup(
     name='steam',
@@ -16,7 +17,7 @@ setup(
     description='Module for interacting with various Steam features',
     long_description=long_description,
     url='https://github.com/ValvePython/steam',
-    author='Rossen Georgiev',
+    author="Rossen Georgiev",
     author_email='[email protected]',
     license='MIT',
     classifiers=[

steam/__init__.py

@@ -1,5 +1,5 @@
-__version__ = "0.5"
+__version__ = "0.5.1"
 __author__ = "Rossen Georgiev"
 
-from .steamid import SteamID
-from .webapi import WebAPI
+from steam.steamid import SteamID
+from steam.webapi import WebAPI

steam/webapi.py

@@ -1,3 +1,4 @@
+from __future__ import print_function
 import requests
 
 
@@ -124,6 +125,10 @@ class WebAPI(object):
             return vdf.load(resp.raw)
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "Steam Web API - List of all interfaces\n\n"
         for interface in self.interfaces:
             doc += interface.doc()
@@ -167,6 +172,10 @@ class WebAPIInterface(object):
         return self._parent.https
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "%s\n%s\n" % (self.name, '-'*len(self.name))
         for method in self.methods:
             doc += "  %s\n" % method.doc().replace("\n", "\n  ")
@@ -204,9 +213,8 @@ class WebAPIMethod(object):
             )
 
     def __call__(self, **kwargs):
-        possible_kwargs = (set(self._dict['parameters'].keys() + ['key', 'format', 'raw']))
-        call_kwargs = set(kwargs.keys())
-        unrecognized = call_kwargs.difference(possible_kwargs)
+        possible_kwargs = set(self._dict['parameters'].keys()) | set(['key', 'format', 'raw'])
+        unrecognized = set(kwargs.keys()).difference(possible_kwargs)
         if unrecognized:
             raise ValueError("Unrecognized parameter %s" % repr(unrecognized.pop()))
 
@@ -224,7 +232,7 @@ class WebAPIMethod(object):
             optional = param['optional']
 
             # raise if we are missing a required parameter
-            if not optional and name not in kwargs:
+            if not optional and name not in kwargs and name != 'key':
                 raise ValueError("Method requires %s to be set" % repr(name))
 
             # populate params that will be passed to _api_request
@@ -276,6 +284,10 @@ class WebAPIMethod(object):
         return self._parent.https
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "%(httpmethod)s %(name)s (v%(version)04d)\n" % self._dict
 
         if 'description' in self._dict: