.. include:: global.rst

``steam`` module documentation
******************************

|pypi| |license|


A python module for intracting with various parts of Steam_.

.. note::
    The module is still very much an alpha.
    API can change without warning

.. note::
    Python 3 is currently not supported,
    see `milestone <https://github.com/ValvePython/steam/milestones/Python%203%20support>`_.

Installing
==========

The latest relase version can be installed from ``PYPI``::

    pip install -U steam

To install the current dev version from `Github repository <https://github.com/ValvePython/steam>`_::

    pip install git+https://github.com/ValvePython/steam

Contributing
============

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
    api/index


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`