From 01f1d8f44983a57a15dbe1c6d1e98fe935bc6d06 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Sat, 14 May 2016 03:05:48 +0100 Subject: [PATCH] docs: added feature list, py3 info, rewording --- README.rst | 22 +++++++++++++++++++--- docs/index.rst | 21 ++++++++++++++++----- docs/user_guide.rst | 18 +++++++++--------- 3 files changed, 44 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index e294130..71938f0 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,24 @@ |pypi| |license| |coverage| |scru| |master_build| -Module for interacting with various Steam_ features. +A python module for interacting with various parts of Steam_. -**Documentation**: http://valvepython.github.io/steam/ +Supports Python ``2.7+`` and ``3.4+``. + +.. note:: + Python 3 support for the SteamClient is not available in the release, + see `issue#10 `_. + +Main features: + +* `SteamID `_ - convert between the various ID representations with ease +* `WebAPI `_ - simple API for Steam's Web API with automatic population of interfaces +* `WebAuth `_ - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com`` +* `SteamClient _` - communication with the steam network based on ``gevent``. + +Checkout the `User guide `_ for examples, + or the `API Reference `_ for details. + +For questions, issues or general curiosity visit the repo at `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:: tox diff --git a/docs/index.rst b/docs/index.rst index 14d0ce5..8d3e2ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,19 +8,30 @@ |pypi| |license| -A python module for intracting with various parts of Steam_. +A python module for interacting with various parts of Steam_. -Visit the `https://github.com/ValvePython/steam `_. +Supports Python ``2.7+`` and ``3.4+``. .. note:: - Python 3 is currently not supported, + Python 3 support for the SteamClient is not available in the release, see `issue#10 `_. +Main features: + +* :class:`SteamID ` - convert between the various ID representations with ease +* :class:`WebAPI ` - simple API for Steam's Web API with automatic population of interfaces +* :class:`WebAuth ` - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com`` +* :class:`SteamClient ` - communication with the steam network based on ``gevent``. + +Checkout the :doc:`user_guide` for examples, or the :doc:`api/index` for details. + +For questions, issues, or general curiosity, visit the repo at `https://github.com/ValvePython/steam `_. + Installing ========== -By default the ``steam`` package doesn't install all dependecies. -Add ``[client]`` extra if you are going to use ``SteamClient``. +By default the ``steam`` package doesn't install all dependencies. +Add ``[client]`` extra if you are going to use :class:`SteamClient `. Install latest version from PYPI:: diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 9530f3b..f007904 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -10,7 +10,7 @@ overview of the functionality available in the ``steam`` module. SteamID ======= -``SteamID`` object can be used to convert the universal steam id +:mod:`SteamID ` can be used to convert the universal steam id to its' various representations. .. note:: @@ -62,8 +62,8 @@ Here are some examples: .. code:: python + >>> SteamID.from_url('https://steamcommunity.com/id/drunkenf00l') >>> steam.steamid.from_url('https://steamcommunity.com/id/drunkenf00l') - >>> steam.steamid.from_url('http://steamcommunity.com/profiles/76561197968459473') SteamID(id=8193745, type='Individual', universe='Public', instance=1) >>> steam.steamid.steam64_from_url('http://steamcommunity.com/profiles/76561197968459473') @@ -73,12 +73,12 @@ Here are some examples: WebAPI ====== -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 ` 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() ` 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 `, or via a :meth:`SteamClient.get_web_session() ` instance. .. code:: python - session = client.get_web_session() # returns request.Session + session = client.get_web_session() # returns requests.Session session.get('https://store.steampowered.com') -For more details about :class:`steam.webauth.WebAuth`, see :doc:`api/steam.webauth` +For more details about :class:`WebAuth `, see :mod:`steam.webauth`