mirror
/
ValvePython.steam
mirror of https://github.com/ValvePython/steam
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
203 Commits
3 Branches
45 Tags
4.1 MiB
 
 
Tree: 45235945b1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '45235945b1'
${ noResults }
Rossen Georgiev 45235945b1
seperate steam client dependencies as an extra 		9 years ago
docs hide inheritance on enum objects 9 years ago
protobufs include source proto in the repo 9 years ago
steam fix serialization in ChannelEncryptRequest 9 years ago
tests added tests for CMClient 9 years ago
vcr added methods for resolving community urls 10 years ago
.coveragerc added .coveragerc 10 years ago
.gitignore added steam client protobufs 10 years ago
.scrutinizer.yml set scrutinizer to expect 1 run 9 years ago
.travis.yml enable cache for Travis CI 9 years ago
LICENSE textwrap LICENSE; tweaks to README 10 years ago
Makefile added --nologcapture to nosetests 9 years ago
README.rst seperate steam client dependencies as an extra 9 years ago
protobuf_list.txt added GC proxy object 9 years ago
requirements.txt seperate steam client dependencies as an extra 9 years ago
setup.py seperate steam client dependencies as an extra 9 years ago
tox.ini remove pypy test; reconf build env 9 years ago

README.rst 

|pypi| |license| |coverage| |scru| |master_build|

Module for interacting with various Steam_ features.

**Documentation**: http://valvepython.github.io/steam/

Installation
------------

By default the ``steam`` package doesn't install all dependecies.
Add ``[client]`` extra if you are going to use ``SteamClient``.

Install latest version from PYPI::

    pip install -U steam
    pip install -U steam[client]

Install the current dev version from ``github``::

    pip install git+https://github.com/ValvePython/steam
    pip install git+https://github.com/ValvePython/steam#egg=steam[client]

For extras syntax in ``requirements.txt`` see `pip docs <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_::

Testing
-------

To run the test suite with the current ``python``, use::

    make test

To run for specific version, setup a ``virtual environment``::

    virtualenv -p python3 py3
    source py3/bin/active
    make test

To run for ``python 2.7``, ``3.3``, ``3.4`` and ``pypy``, assuming you have them installed::

    tox


.. _Steam: https://store.steampowered.com/

.. |pypi| image:: https://img.shields.io/pypi/v/steam.svg?style=flat&label=latest%20version
    :target: https://pypi.python.org/pypi/steam
    :alt: Latest version released on PyPi

.. |license| image:: https://img.shields.io/pypi/l/steam.svg?style=flat&label=license
    :target: https://pypi.python.org/pypi/steam
    :alt: MIT License

.. |coverage| image:: https://img.shields.io/coveralls/ValvePython/steam/master.svg?style=flat
    :target: https://coveralls.io/r/ValvePython/steam?branch=master
    :alt: Test coverage

.. |scru| image:: https://scrutinizer-ci.com/g/ValvePython/steam/badges/quality-score.png?b=master
    :target: https://scrutinizer-ci.com/g/ValvePython/steam/?branch=master
    :alt: Scrutinizer score

.. |master_build| image:: https://img.shields.io/travis/ValvePython/steam/master.svg?style=flat&label=master
    :target: http://travis-ci.org/ValvePython/steam
    :alt: Build status of master branch