Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 3.12 KB

README.rst

File metadata and controls

84 lines (53 loc) · 3.12 KB
Raw

A python module for interacting with various parts of Steam.

A fork of ValvePython/steam, which has apparently been abandoned.

Supports Python 3.6+.

Documentation (WARNING - out of date): http://steam.readthedocs.io/en/latest/

Features

  • SteamClient - communication with the steam network based on gevent.
  • CDNClient - access to Steam content depots
  • WebAuth - authentication for access to store.steampowered.com and steamcommunity.com
  • WebAPI - simple API for Steam's Web API with automatic population of interfaces
  • SteamAuthenticator - enable/disable/manage two factor authentication for Steam accounts
  • SteamID - convert between the various ID representations with ease
  • Master Server Query Protocol - query masters servers directly or via SteamClient

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/solsticegamestudios/steam.

Like using the command line? Try steamctl tool

Install

For system specific details, see Installation Details.

WARNING: Only ValvePython's (out of date) version is on PyPI.

Installing directly from github repository:

# cutting edge from master
pip install "git+https://github.com/solsticegamestudios/steam#egg=steam"

# specific version tag (e.g. v1.0.0)
pip install "git+https://github.com/solsticegamestudios/[email protected]#egg=steam[client]"
# without SteamClient extras
pip install "git+https://github.com/solsticegamestudios/[email protected]#egg=steam"

Vagrant

The repo includes a Vagrantfile to setup environment for experimentation and development. We assume you've already have vagrant and virtualbox set up. The VM is Ubuntu 16.04 with all necessary packages installed, and virtualenv for python2 and python3.

vagrant up    # spin the VM and let it setup
vagrant ssh
# for python2
$ source venv2/bin/activate
# for python3
$ source venv3/bin/activate

Local 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
pip install -r requirements.txt
make test