Browse Source

docs: added feature list, py3 info, rewording

pull/34/head
Rossen Georgiev 9 years ago
parent
commit
01f1d8f449
  1. 22
      README.rst
  2. 21
      docs/index.rst
  3. 18
      docs/user_guide.rst

22
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 <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::
tox

21
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 <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 <https://github.com/ValvePython/steam/issues/10>`_.
Main features:
* :class:`SteamID <steam.steamid.SteamID>` - convert between the various ID representations with ease
* :class:`WebAPI <steam.webapi.WebAPI>` - simple API for Steam's Web API with automatic population of interfaces
* :class:`WebAuth <steam.webauth.WebAuth>` - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``
* :class:`SteamClient <steam.client.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 <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 <steam.client.SteamClient>`.
Install latest version from PYPI::

18
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 <steam.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 <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.
.. 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 <steam.webauth.WebAuth>`, see :mod:`steam.webauth`

Loading…
Cancel
Save