Steam Client

A Python library for interacting with a locally installed Steam client — enumerate your game library/non-steam games, read game metadata and artwork paths, and send Steam URI commands.

Docs

Buy Me a Coffee Ko-fi

Installation

Requires Python 3.11+.

pip install steam-client

Or install from source:

pip install -e .

Quickstart

from steam_client.steam import Steam

steam = Steam()  # Uses default path: C:\Program Files (x86)\Steam

# On Windows, auto-detect path from registry:
from steam_client.utils import steam_from_registry
steam = steam_from_registry()

Common Operations

List all installed games

for game in steam.library.games():
    print(game.appid, game.name)

Find a game

game = steam.library.game_by_id("440")       # by app ID
game = steam.library.game_by_name("Portal 2") # by name (case-insensitive)

Artwork paths

game.header   # Path to header image    (460×215 jpg)
game.grid     # Path to grid image      (600×900 jpg)
game.hero     # Path to hero image
game.icon     # Path to icon file, or None

Launch and manage games via Steam URI commands

from steam_client import commands
from steam_client.commands import SteamWindow

commands.run_game_id("440")               # Launch a game
commands.store("440")                     # Open store page
commands.install("440")                   # Prompt install
commands.uninstall("440")                 # Prompt uninstall
commands.open_window(SteamWindow.FRIENDS) # Open a Steam window
commands.open_url("https://store.steampowered.com")

Or launch a game directly from a Game object:

game.run()

Users and shortcuts

for user in steam.users:
    print(user.user.data.PersonaName)

for shortcut in steam.library.shortcuts():
    print(shortcut.name)

If Steam is not installed at the given path, calls that read Steam data raise steam_client.SteamNotFoundError.

Platform Notes

Platform Path Registry helper
Windows C:\Program Files (x86)\Steam (default) steam_from_registry()
Linux Pass yours, e.g. ~/.local/share/Steam Not available

Pass a custom path to override the default:

steam = Steam("/custom/steam/path")

Requires read access to local Steam config files (libraryfolders.vdf, shortcuts.vdf, appmanifest files).

Development

pytest          # Run tests
flake8 steam_client  # Lint
mypy steam_client    # Type check
mkdocs serve         # Preview docs locally
mkdocs build --strict # Validate docs build
tox             # Run all environments (lint, type, docs, py311–314)

bump-my-version show current_version   # Show current version
bump-my-version bump patch             # 4.0.0 → 4.0.1
bump-my-version bump minor             # 4.0.0 → 4.1.0
bump-my-version bump major             # 4.0.0 → 5.0.0

Project links

Data verified by PyPI on Jul 31, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (6.0.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Garulf from gravatar.com Garulf

Credits

Author: William McAllister

GitHub Statistics

Data verified by PyPI on Jul 31, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT)

Requires

Python >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

steam_client-6.0.1.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

steam_client-6.0.1-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file steam_client-6.0.1.tar.gz.

File metadata

  • Download URL: steam_client-6.0.1.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for steam_client-6.0.1.tar.gz
Algorithm Hash digest
SHA256 ecf6130dffe45fbf2f051a9d73de26080ac273392661a60433b006fe9dcf37a1
MD5 fbe0af13d956b6c48c866080fdce603f
BLAKE2b-256 486ca5fe7ca6ad13353879388a9fbf72015f69b155c55f669b2eee56de92242f

See more details on using hashes here.

Provenance

The following attestation bundles were made for steam_client-6.0.1.tar.gz:

Publisher: release-please.yaml on Garulf/Steam-Client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file steam_client-6.0.1-py3-none-any.whl.

File metadata

  • Download URL: steam_client-6.0.1-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for steam_client-6.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 44c4ec1a060db96e14fcf692c9dbeb9184325517f1570a7737d6fe1ea7727b5f
MD5 1da3cabd594326f92c7f6b1e59001195
BLAKE2b-256 c3f6940292cd59d1a86af7170f9bc608f905bb78b0d3d10a239ce47ce25c798b

See more details on using hashes here.

Provenance

The following attestation bundles were made for steam_client-6.0.1-py3-none-any.whl:

Publisher: release-please.yaml on Garulf/Steam-Client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page