Python 3 support for the SteamClient is not available in the release,
see `issue#10 <https://github.com/ValvePython/steam/issues/10>`_.
Main features:
* `SteamID <http://valvepython.github.io/steam/api/steam.client.html>`_ - convert between the various ID representations with ease
* `WebAPI <http://valvepython.github.io/steam/api/steam.webapi.html>`_ - simple API for Steam's Web API with automatic population of interfaces
* `WebAuth <http://valvepython.github.io/steam/api/steam.webauth.html>`_ - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``
* `SteamClient <http://valvepython.github.io/steam/api/steam.client.html>_` - communication with the steam network based on ``gevent``.
Checkout the `User guide <http://valvepython.github.io/steam/user_guide.html>`_ for examples,
or the `API Reference <http://valvepython.github.io/steam/api/index.html>`_ for details.
For questions, issues or general curiosity visit the repo at `https://github.com/ValvePython/steam <https://github.com/ValvePython/steam>`_.
Installation
------------
@ -35,7 +51,7 @@ To run for specific version, setup a ``virtual environment``::
source py3/bin/active
make test
To run for ``python 2.7``, ``3.3``,``3.4`` and ``pypy``, assuming you have them installed::
To run for ``python 2.7`` and``3.4`` assuming you have them installed::
Wrapper around `Steam Web API`_. Requires `API Key`_. Upon initialization the
instance will fetch all available interfaces from the API and populate the namespace.
:mod:`WebAPI <steam.webapi>` is a thin Wrapper around `Steam Web API`_. Requires `API Key`_. Upon initialization the
instance will fetch all available interfaces and populate the namespace.
..note::
Interface availability depends on the ``key``.
Unless data is loaded manually.
Unless the schema is loaded manually.
Example usage
-------------
@ -200,7 +200,7 @@ Sending a message
-----------------
Example of sending a protobuf message and handling the response.
`send_message_and_wait` will send a message and block until the specified event.
:meth:`send_message_and_wait() <steam.client.SteamClient.send_message_and_wait>` will send a message and block until the specified event.
..code:: python
@ -235,11 +235,11 @@ Web Authentication
==================
There are currently two paths for gaining accessing to steam websites.
Either using :class:`steam.webauth.WebAuth`, or via a :class:`steam.client.SteamClient` instance.
Either using :class:`WebAuth <steam.webauth.WebAuth>`, or via a :meth:`SteamClient.get_web_session() <steam.client.builtins.web.Web.get_web_session>` instance.