| |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/
Features
--------
* `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 depots
* `WebAuth <http://steam.readthedocs.io/en/stable/api/steam.webauth.html>`_ - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``
* `WebAPI <http://steam.readthedocs.io/en/stable/api/steam.webapi.html>`_ - simple API for Steam's Web API with automatic population of interfaces
* `SteamAuthenticator <http://steam.readthedocs.io/en/stable/api/steam.guard.html>`_ - enable/disable/manage two factor authentication for Steam accounts
* `SteamID <http://steam.readthedocs.io/en/stable/api/steam.steamid.html>`_ - convert between the various ID representations with ease
* `Master Server Query Protocol <https://steam.readthedocs.io/en/stable/api/steam.game_servers.html>`_ - query masters servers directly or via ``SteamClient``
Checkout 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
Install
-------
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"
Vagrant
-------
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
Local Testing
-------------
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
Contact
-------
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
Raw data
{
"_id": null,
"home_page": "https://github.com/ValvePython/steam",
"name": "steam",
"maintainer": "",
"docs_url": "https://pythonhosted.org/steam/",
"requires_python": "",
"maintainer_email": "",
"keywords": "valve steam steamid api webapi steamcommunity",
"author": "Rossen Georgiev",
"author_email": "rossen@rgp.io",
"download_url": "https://files.pythonhosted.org/packages/9a/31/62ac25584988182dee5ee949395e08943ff8b11634dc33abab7078d28433/steam-1.4.4.tar.gz",
"platform": null,
"description": "| |pypi| |latest| |pypipy| |license|\n| |coverage| |master_build| |docs|\n| |sonar_maintainability| |sonar_reliability| |sonar_security|\n\nA python module for interacting with various parts of Steam_.\n\nSupports Python ``2.7+`` and ``3.4+``.\n\nDocumentation: http://steam.readthedocs.io/en/stable/\n\nFeatures\n--------\n\n* `SteamClient <http://steam.readthedocs.io/en/stable/api/steam.client.html>`_ - communication with the steam network based on ``gevent``.\n* `CDNClient <http://steam.readthedocs.io/en/stable/api/steam.client.cdn.html>`_ - access to Steam content depots\n* `WebAuth <http://steam.readthedocs.io/en/stable/api/steam.webauth.html>`_ - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``\n* `WebAPI <http://steam.readthedocs.io/en/stable/api/steam.webapi.html>`_ - simple API for Steam's Web API with automatic population of interfaces\n* `SteamAuthenticator <http://steam.readthedocs.io/en/stable/api/steam.guard.html>`_ - enable/disable/manage two factor authentication for Steam accounts\n* `SteamID <http://steam.readthedocs.io/en/stable/api/steam.steamid.html>`_ - convert between the various ID representations with ease\n* `Master Server Query Protocol <https://steam.readthedocs.io/en/stable/api/steam.game_servers.html>`_ - query masters servers directly or via ``SteamClient``\n\nCheckout the `User guide <http://steam.readthedocs.io/en/stable/user_guide.html>`_ for examples,\nor the `API Reference <http://steam.readthedocs.io/en/stable/api/steam.html>`_ for details.\n\nFor questions, issues or general curiosity visit the repo at `https://github.com/ValvePython/steam <https://github.com/ValvePython/steam>`_.\n\nLike using the command line? Try `steamctl <https://github.com/ValvePython/steamctl>`_ tool\n\nInstall\n-------\n\nFor system specific details, see `Installation Details <http://steam.readthedocs.io/en/stable/install.html>`_.\n\nInstall latest release version from PYPI:\n\n.. code:: bash\n\n # with SteamClient dependecies\n pip install -U \"steam[client]\"\n\n # without (only when using parts that do no rely on gevent, and protobufs)\n pip install -U steam\n\nInstalling directly from ``github`` repository:\n\n.. code:: bash\n\n # cutting edge from master\n pip install \"git+https://github.com/ValvePython/steam#egg=steam\"\n\n # specific version tag (e.g. v1.0.0)\n pip install \"git+https://github.com/ValvePython/steam@v1.0.0#egg=steam[client]\"\n # without SteamClient extras\n pip install \"git+https://github.com/ValvePython/steam@v1.0.0#egg=steam\"\n\nVagrant\n-------\n\nThe repo includes a `Vagrantfile` to setup enviroment for expermentation and development.\nWe assume you've already have ``vagrant`` and ``virtualbox`` set up.\nThe VM is ``Ubuntu 16.04`` with all necessary packages installed, and virtualenv for ``python2`` and ``python3``.\n\n\n.. code:: bash\n\n vagrant up # spin the VM and let it setup\n vagrant ssh\n # for python2\n $ source venv2/bin/activate\n # for python3\n $ source venv3/bin/activate\n\n\n\nLocal Testing\n-------------\n\nTo run the test suite with the current ``python``, use\n\n.. code:: bash\n\n make test\n\nTo run for specific version, setup a virtual environment\n\n.. code:: bash\n\n virtualenv -p python3 py3\n source py3/bin/active\n pip install -r requirements.txt\n make test\n\nContact\n-------\n\nIRC: irc.libera.chat / #steamre (`join via webchat <https://web.libera.chat/#steamre>`_)\n\n\n.. _Steam: https://store.steampowered.com/\n\n.. |pypi| image:: https://img.shields.io/pypi/v/steam.svg?label=pypi&color=green\n :target: https://pypi.python.org/pypi/steam\n :alt: Latest version released on PyPi\n\n.. |latest| image:: https://img.shields.io/github/v/tag/ValvePython/steam?include_prereleases&sort=semver&label=release\n :target: https://github.com/ValvePython/steam/releases\n :alt: Latest release on Github\n\n.. |pypipy| image:: https://img.shields.io/pypi/pyversions/steam.svg?label=%20&logo=python&logoColor=white\n :alt: PyPI - Python Version\n\n.. |license| image:: https://img.shields.io/pypi/l/steam.svg?style=flat&label=license\n :target: https://pypi.python.org/pypi/steam\n :alt: MIT License\n\n.. |coverage| image:: https://img.shields.io/coveralls/ValvePython/steam/master.svg?style=flat\n :target: https://coveralls.io/r/ValvePython/steam?branch=master\n :alt: Test coverage\n\n.. |sonar_maintainability| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=sqale_rating\n :target: https://sonarcloud.io/dashboard?id=ValvePython_steam\n :alt: SonarCloud Rating\n\n.. |sonar_reliability| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=reliability_rating\n :target: https://sonarcloud.io/dashboard?id=ValvePython_steam\n :alt: SonarCloud Rating\n\n.. |sonar_security| image:: https://sonarcloud.io/api/project_badges/measure?project=ValvePython_steam&metric=security_rating\n :target: https://sonarcloud.io/dashboard?id=ValvePython_steam\n :alt: SonarCloud Rating\n\n.. |master_build| image:: https://img.shields.io/travis/ValvePython/steam/master.svg?style=flat&label=master\n :target: http://travis-ci.org/ValvePython/steam/branches\n :alt: Build status of master branch\n\n.. |docs| image:: https://readthedocs.org/projects/steam/badge/?version=stable\n :target: http://steam.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation status\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Module for interacting with various Steam features",
"version": "1.4.4",
"split_keywords": [
"valve",
"steam",
"steamid",
"api",
"webapi",
"steamcommunity"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "04f11e564cf8e848da360d02e27d3801",
"sha256": "2b5bd6911c0d4a7312f441b8d162b9d8d47c8bebb8efc6c8867393b0323fa52e"
},
"downloads": -1,
"filename": "steam-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "04f11e564cf8e848da360d02e27d3801",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 644071,
"upload_time": "2022-12-10T11:16:22",
"upload_time_iso_8601": "2022-12-10T11:16:22.757292Z",
"url": "https://files.pythonhosted.org/packages/9a/31/62ac25584988182dee5ee949395e08943ff8b11634dc33abab7078d28433/steam-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-10 11:16:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ValvePython",
"github_project": "steam",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "six",
"specs": [
[
">=",
"1.10.0"
]
]
},
{
"name": "pycryptodomex",
"specs": [
[
">=",
"3.7.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.9.1"
]
]
},
{
"name": "vdf",
"specs": [
[
">=",
"3.3"
]
]
},
{
"name": "gevent",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
"~=",
"3.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
"<",
"3.18.0"
]
]
},
{
"name": "gevent-eventemitter",
"specs": [
[
"~=",
"2.1"
]
]
},
{
"name": "cachetools",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "enum34",
"specs": [
[
"==",
"1.1.2"
]
]
},
{
"name": "win-inet-pton",
"specs": []
}
],
"tox": true,
"lcname": "steam"
}
JSON
