| |pypi| |latest| |pypipy| |license| | |coverage| |master_build| |docs| | |sonar_maintainability| |sonar_reliability| |sonar_security|
A python module for interacting with various parts of Steam_.
Supports Python 2.7+ and 3.4+.
Documentation: http://steam.readthedocs.io/en/stable/
SteamClient <http://steam.readthedocs.io/en/stable/api/steam.client.html>_ - communication with the steam network based on gevent.CDNClient <http://steam.readthedocs.io/en/stable/api/steam.client.cdn.html>_ - access to Steam content depotsWebAuth <http://steam.readthedocs.io/en/stable/api/steam.webauth.html>_ - authentication for access to store.steampowered.com and steamcommunity.comWebAPI <http://steam.readthedocs.io/en/stable/api/steam.webapi.html>_ - simple API for Steam's Web API with automatic population of interfacesSteamAuthenticator <http://steam.readthedocs.io/en/stable/api/steam.guard.html>_ - enable/disable/manage two factor authentication for Steam accountsSteamID <http://steam.readthedocs.io/en/stable/api/steam.steamid.html>_ - convert between the various ID representations with easeMaster Server Query Protocol <https://steam.readthedocs.io/en/stable/api/steam.game_servers.html>_ - query masters servers directly or via SteamClientCheckout the User guide <http://steam.readthedocs.io/en/stable/user_guide.html>_ for examples,
or the API Reference <http://steam.readthedocs.io/en/stable/api/steam.html>_ for details.
For questions, issues or general curiosity visit the repo at https://github.com/ValvePython/steam <https://github.com/ValvePython/steam>_.
Like using the command line? Try steamctl <https://github.com/ValvePython/steamctl>_ tool
For system specific details, see Installation Details <http://steam.readthedocs.io/en/stable/install.html>_.
Install latest release version from PYPI:
.. code:: bash
# with SteamClient dependecies
pip install -U "steam[client]"
# without (only when using parts that do no rely on gevent, and protobufs)
pip install -U steam
Installing directly from github repository:
.. code:: bash
# cutting edge from master
pip install "git+https://github.com/ValvePython/steam#egg=steam"
# specific version tag (e.g. v1.0.0)
pip install "git+https://github.com/ValvePython/steam@v1.0.0#egg=steam[client]"
# without SteamClient extras
pip install "git+https://github.com/ValvePython/steam@v1.0.0#egg=steam"
The repo includes a Vagrantfile to setup enviroment for expermentation 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.
.. code:: bash
vagrant up # spin the VM and let it setup
vagrant ssh
# for python2
$ source venv2/bin/activate
# for python3
$ source venv3/bin/activate
To run the test suite with the current python, use
.. code:: bash
make test
To run for specific version, setup a virtual environment
.. code:: bash
virtualenv -p python3 py3
source py3/bin/active
pip install -r requirements.txt
make test
IRC: irc.libera.chat / #steamre (join via webchat <https://web.libera.chat/#steamre>_)
.. _Steam: https://store.steampowered.com/
.. |pypi| image:: https://img.shields.io/pypi/v/steam.svg?label=pypi&color=green :target: https://pypi.python.org/pypi/steam :alt: Latest version released on PyPi
.. |latest| image:: https://img.shields.io/github/v/tag/ValvePython/steam?include_prereleases&sort=semver&label=release :target: https://github.com/ValvePython/steam/releases :alt: Latest release on Github
.. |pypipy| image:: https://img.shields.io/pypi/pyversions/steam.svg?label=%20&logo=python&logoColor=white :alt: PyPI - Python Version
.. |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
.. |sonar_maintainability| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=sqale_rating :target: https://sonarcloud.io/dashboard?id=ValvePython_steam :alt: SonarCloud Rating
.. |sonar_reliability| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=reliability_rating :target: https://sonarcloud.io/dashboard?id=ValvePython_steam :alt: SonarCloud Rating
.. |sonar_security| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=security_rating :target: https://sonarcloud.io/dashboard?id=ValvePython_steam :alt: SonarCloud Rating
.. |master_build| image:: https://img.shields.io/travis/ValvePython/steam/master.svg?style=flat&label=master :target: http://travis-ci.org/ValvePython/steam/branches :alt: Build status of master branch
.. |docs| image:: https://readthedocs.org/projects/steam/badge/?version=stable :target: http://steam.readthedocs.io/en/stable/?badge=stable :alt: Documentation status
FAQs
Module for interacting with various Steam features
We found that steam demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.