added steam.client features to docs

* various other docs alterations
* moved games played under features.misc

docs/.gitignore

@@ -1,3 +1,4 @@
+_build
 _doc
 _static
 _templates

docs/api/steam.client.features.rst

@@ -0,0 +1,21 @@
+steam.client.features
+=====================
+
+.. automodule:: steam.client.features
+
+User
+----
+
+.. automodule:: steam.client.features.user
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Misc
+----
+
+.. automodule:: steam.client.features.misc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/api/steam.client.gc.rst

@@ -0,0 +1,7 @@
+steam.client.gc
+===============
+
+.. automodule:: steam.client.gc
+    :members:
+    :show-inheritance:
+

docs/api/steam.client.rst

@@ -1,15 +1,10 @@
 steam.client
 ============
 
-.. automodule:: steam.client
+.. toctree::
-    :members:
+    steam.client.features
-    :show-inheritance:
+    steam.client.gc
-
-steam.client.gc
----------------
 
-.. automodule:: steam.client.gc
+.. automodule:: steam.client
     :members:
     :show-inheritance:
-
-

docs/api/steam.rst

@@ -1,18 +1,17 @@
 steam
 =====
 
-.. automodule:: steam
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 .. toctree::
-
     steam.client
     steam.core
     steam.enums
     steam.util
 
+.. automodule:: steam
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 steam.steamid
 -------------
 

docs/index.rst

@@ -1,3 +1,5 @@
+:tocdepth: 10
+
 .. include:: global.rst
 
 ``steam`` module documentation
@@ -8,6 +10,8 @@
 
 A python module for intracting with various parts of Steam_.
 
+Visit the `Github repository <https://github.com/ValvePython/steam>`_.
+
 .. note::
     The module is still very much an alpha.
     API can change without warning
@@ -27,22 +31,15 @@ To install the current dev version from `Github repository <https://github.com/V
 
     pip install git+https://github.com/ValvePython/steam
 
-Contributing
+Contents
-============
+========
-
-Issues, suggestions, and code contributions are welcome.
-Just head on to the `Github repostory <https://github.com/ValvePython/steam>`_.
-
-Table of contents
-=================
 
 .. toctree::
     :maxdepth: 3
 
-    quick_start
+    user_guide
     api/index
 
-
 Indices and tables
 ==================
 

docs/quick_start.rst → docs/user_guide.rst

@@ -1,7 +1,7 @@
 .. include:: global.rst
 
-Quick start
+User guide
-***********
+**********
 
 Welcome to the quick start section.
 The aim here is to give you a very quick

steam/__init__.py

@@ -1,7 +1,7 @@
-__version__ = "0.6.1"
+__version__ = "0.6.2"
 __author__ = "Rossen Georgiev"
 
-version_info = (0, 6, 1)
+version_info = (0, 6, 2)
 
 from steam.steamid import SteamID
 from steam.webapi import WebAPI

steam/client/__init__.py

@@ -356,22 +356,3 @@ class SteamClient(EventEmitter, FeatureBase):
         """
         while True:
             gevent.sleep(300)
-
-    def games_played(self, app_ids):
-        """
-        Set the application being played by the user
-
-        :param app_ids: a list of application ids
-        :type app_ids: :class:`list`
-        """
-        if not isinstance(app_ids, list):
-            raise ValueError("Expected app_ids to be of type list")
-
-        app_ids = map(int, app_ids)
-
-        message = MsgProto(EMsg.ClientGamesPlayed)
-        GamePlayed = message.body.GamePlayed
-
-        message.body.games_played.extend(map(lambda x: GamePlayed(game_id=x), app_ids))
-
-        self.send(message)

steam/client/features/__init__.py

@@ -1,4 +1,10 @@
-class FeatureBase(object):
+"""
+All high level features of :class:`steam.client.SteamClient` are here in seperate submodules.
+"""
+from steam.client.features.misc import Misc
+from steam.client.features.user import User
+
+class FeatureBase(Misc, User):
     """
     This object is used as base to implement all high level functionality.
     The features are seperated into submodules.

steam/client/features/misc.py

@@ -0,0 +1,26 @@
+"""
+Various features that don't have a category
+"""
+
+class Misc(object):
+    def __init__(self):
+        super(Misc, self).__init__()
+
+    def games_played(self, app_ids):
+        """
+        Set the application being played by the user
+
+        :param app_ids: a list of application ids
+        :type app_ids: :class:`list`
+        """
+        if not isinstance(app_ids, list):
+            raise ValueError("Expected app_ids to be of type list")
+
+        app_ids = map(int, app_ids)
+
+        message = MsgProto(EMsg.ClientGamesPlayed)
+        GamePlayed = message.body.GamePlayed
+
+        message.body.games_played.extend(map(lambda x: GamePlayed(game_id=x), app_ids))
+
+        self.send(message)

steam/client/features/user.py

@@ -0,0 +1,4 @@
+
+class User(object):
+    def __init__(self):
+        super(User, self).__init__()

steam/client/gc.py

@@ -1,5 +1,5 @@
 """
-Example usage for messeages to the Dota 2 GC.
+Example usage for messages to the Dota 2 GC.
 
 .. code:: python
 

steam/enums/common.py

@@ -6,6 +6,7 @@ __all__ = [
     'EType',
     'EServerType',
     'EOSType',
+    'EPersonaState',
     ]
 
 
@@ -257,3 +258,14 @@ class EOSType(SteamIntEnum):
     WinMAX = 15
 
     Max = 26
+
+
+class EPersonaState(SteamIntEnum):
+    Offline = 0
+    Online = 1
+    Busy = 2
+    Away = 3
+    Snooze = 4
+    LookingToTrade = 5
+    LookingToPlay = 6
+    Max = 7