steam-client 3.0.0.dev0__tar.gz → 4.1.0__tar.gz

steam_client-4.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: steam-client
+Version: 4.1.0
+Summary: Steam client library for Python
+Author-email: William McAllister <dev.garulf@gmail.com>
+License: MIT
+Project-URL: Source, https://github.com/garulf/steam-client
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: vdf>=3.4
+Requires-Dist: pycrc>=0.10.0
+Dynamic: license-file
+
+# 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](https://img.shields.io/badge/docs-mkdocs%20material-0A7BBB?style=flat&logo=materialformkdocs&logoColor=white)](docs/index.md)
+
+[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-garulf-FFDD00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/garulf)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-garulf-FF5E5B?style=flat&logo=ko-fi&logoColor=white)](https://ko-fi.com/garulf)
+
+---
+
+## Installation
+
+Requires Python 3.8+.
+
+```bash
+pip install steam-client
+```
+
+Or install from source:
+
+```bash
+pip install -e .
+```
+
+---
+
+## Quickstart
+
+```python
+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
+
+```python
+for game in steam.library.games():
+    print(game.appid, game.name)
+```
+
+### Find a game
+
+```python
+game = steam.library.game_by_id("440")       # by app ID
+game = steam.library.game_by_name("Portal 2") # by name (case-insensitive)
+```
+
+### Artwork paths
+
+```python
+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
+
+```python
+from steam_client.commands import Commands, SteamWindows
+
+commands = Commands()
+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(SteamWindows.FRIENDS) # Open a Steam window
+commands.open_url("https://store.steampowered.com")
+```
+
+Or launch a game directly from a `SteamGame` object:
+
+```python
+game.run()
+```
+
+### Users and shortcuts
+
+```python
+for user in steam.users:
+    print(user.user.data.PersonaName)
+
+for shortcut in steam.library.shortcuts():
+    print(shortcut.appname)
+```
+
+## Platform Notes
+
+| Platform | Default path                   | Registry helper         |
+|----------|--------------------------------|-------------------------|
+| Windows  | `C:\Program Files (x86)\Steam` | `steam_from_registry()` |
+| Linux    | `~/.local/share/steam`         | Not available           |
+
+Pass a custom path to override the default:
+
+```python
+steam = Steam("/custom/steam/path")
+```
+
+Requires read access to local Steam config files (`libraryfolders.vdf`, `shortcuts.vdf`, appmanifest files).
+
+---
+
+## Development
+
+```bash
+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
+```

steam_client-4.1.0/README.md

@@ -0,0 +1,128 @@
+# 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](https://img.shields.io/badge/docs-mkdocs%20material-0A7BBB?style=flat&logo=materialformkdocs&logoColor=white)](docs/index.md)
+
+[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-garulf-FFDD00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/garulf)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-garulf-FF5E5B?style=flat&logo=ko-fi&logoColor=white)](https://ko-fi.com/garulf)
+
+---
+
+## Installation
+
+Requires Python 3.8+.
+
+```bash
+pip install steam-client
+```
+
+Or install from source:
+
+```bash
+pip install -e .
+```
+
+---
+
+## Quickstart
+
+```python
+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
+
+```python
+for game in steam.library.games():
+    print(game.appid, game.name)
+```
+
+### Find a game
+
+```python
+game = steam.library.game_by_id("440")       # by app ID
+game = steam.library.game_by_name("Portal 2") # by name (case-insensitive)
+```
+
+### Artwork paths
+
+```python
+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
+
+```python
+from steam_client.commands import Commands, SteamWindows
+
+commands = Commands()
+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(SteamWindows.FRIENDS) # Open a Steam window
+commands.open_url("https://store.steampowered.com")
+```
+
+Or launch a game directly from a `SteamGame` object:
+
+```python
+game.run()
+```
+
+### Users and shortcuts
+
+```python
+for user in steam.users:
+    print(user.user.data.PersonaName)
+
+for shortcut in steam.library.shortcuts():
+    print(shortcut.appname)
+```
+
+## Platform Notes
+
+| Platform | Default path                   | Registry helper         |
+|----------|--------------------------------|-------------------------|
+| Windows  | `C:\Program Files (x86)\Steam` | `steam_from_registry()` |
+| Linux    | `~/.local/share/steam`         | Not available           |
+
+Pass a custom path to override the default:
+
+```python
+steam = Steam("/custom/steam/path")
+```
+
+Requires read access to local Steam config files (`libraryfolders.vdf`, `shortcuts.vdf`, appmanifest files).
+
+---
+
+## Development
+
+```bash
+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
+```

{steam_client-3.0.0.dev0 → steam_client-4.1.0}/pyproject.toml

@@ -6,7 +6,7 @@ name = "steam-client"
 authors = [
     {name = "William McAllister", email = "dev.garulf@gmail.com"}
 ]
-version = "3.0.0-dev.0"
+version = "4.1.0"
 description = "Steam client library for Python"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -30,34 +30,4 @@ packages = ["steam_client"]
 [tool.setuptools.package-data]
 "steam_client" = ["py.typed"]
 
-[tool.bumpversion]
-current_version = "3.0.0-dev.0"
-search = "version = \"{current_version}\""
-replace = "version = \"{new_version}\""
-parse = """(?x)
-    (?P<major>[0-9]+)
-    \\.(?P<minor>[0-9]+)
-    \\.(?P<patch>[0-9]+)
-    (?:
-        -(?P<label>dev|rc|release)
-        (?:.(?P<label_n>[0-9]+))?
-    )?
-"""
-serialize = [
-    "{major}.{minor}.{patch}-{label}.{label_n}",
-    "{major}.{minor}.{patch}",
-]
-tag = true
-allow_dirty = false
-commit = true
-
-[tool.bumpversion.parts.label]
-optional_value = "release"
-values =[
-	"dev",
-	"rc",
-	"release",
-]
 
-[[tool.bumpversion.files]]
-filename = "pyproject.toml"

steam_client-4.1.0/steam_client/__init__.py

@@ -0,0 +1,3 @@
+from steam_client.steam import Steam
+
+__all__ = ["Steam"]

{steam_client-3.0.0.dev0 → steam_client-4.1.0}/steam_client/app.py

@@ -1,20 +1,14 @@
 from __future__ import annotations
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import TYPE_CHECKING
-
 
 from .commands import Commands
 
-if TYPE_CHECKING:
-    from .steam import Steam
-
 
 class App(ABC):
     """Abstract base class for all Steam apps."""
 
-    def __init__(self, steam: Steam):
-        self._steam = steam
+    def __init__(self):
         self._commands = Commands()
 
     @property

{steam_client-3.0.0.dev0 → steam_client-4.1.0}/steam_client/commands.py

@@ -1,8 +1,9 @@
-from typing import List
 import webbrowser
 from enum import StrEnum
 
-SCHEME = 'steam'
+
+def _create_uri(*segments: str) -> str:
+    return f'steam://{"/".join(segments)}'
 
 
 class SteamWindows(StrEnum):
@@ -21,49 +22,36 @@ class SteamWindows(StrEnum):
     CONSOLE = 'console'
 
 
-class Command():
-
-    def __init__(self, scheme: str):
-        self._scheme = scheme
-
-    def _create_uri(self, path: List[str], endpoint: str) -> str:
-        return f'{self._scheme}://{"/".join(path)}/{endpoint}'
-
-    def __call__(self, path: List[str], endpoint: str) -> None:
-        """Executes the command with the specified endpoint."""
-        webbrowser.open(self._create_uri(path, endpoint))
-
-
 class Commands:
     """A collection of commands for the Steam client."""
 
-    def __init__(self):
-        self._command = Command(SCHEME)
+    def _open(self, *segments: str) -> None:
+        webbrowser.open(_create_uri(*segments))
 
     def run_game_id(self, app_id: str) -> None:
         """Launches game with the specified ID in the Steam client."""
-        self._command(['rungameid'], app_id)
+        self._open('rungameid', app_id)
 
     def store(self, app_id: str) -> None:
         """Opens the game's store page in the Steam client."""
-        self._command(['store'], app_id)
+        self._open('store', app_id)
 
     def install(self, app_id: str) -> None:
         """Opens the game's install prompt in the Steam client."""
-        self._command(['install'], app_id)
+        self._open('install', app_id)
 
     def uninstall(self, app_id: str) -> None:
         """Opens the game's uninstall prompt in the Steam client."""
-        self._command(['uninstall'], app_id)
+        self._open('uninstall', app_id)
 
     def update_news(self, app_id: str) -> None:
         """Opens the game's update news in the Steam client."""
-        self._command(['updatenews'], app_id)
+        self._open('updatenews', app_id)
 
     def open(self, window: SteamWindows) -> None:
         """Opens the specified window in the Steam client."""
-        self._command(['open'], window)
+        self._open('open', window)
 
     def open_url(self, url: str) -> None:
         """Opens the specified URL in the Steam client."""
-        self._command(['openurl'], url)
+        self._open('openurl', url)

{steam_client-3.0.0.dev0 → steam_client-4.1.0}/steam_client/game.py

@@ -1,13 +1,9 @@
 from __future__ import annotations
 import functools
 from pathlib import Path
-from typing import TYPE_CHECKING
 
 import vdf  # type: ignore
 
-if TYPE_CHECKING:
-    from .steam import Steam
-
 from .app import App
 
 
@@ -22,19 +18,20 @@ ASSETS = frozenset({
 })
 
 
-class SteamGame(App):
+class Game(App):
     """Represents a Steam game."""
 
-    def __init__(self, steam: Steam, library_path: str, appid: str):
+    def __init__(self, library_cache_path: Path, library_path: str, appid: str):
+        self._library_cache_path = Path(library_cache_path)
         self.library_path = library_path
         self._appid = appid
         self._icon: Path | None = None
         self._name: str | None = None
-        super().__init__(steam)
+        super().__init__()
 
     def __repr__(self) -> str:
         return (
-            f'Game(steam={self._steam.__repr__()}, '
+            f'Game(library_cache_path={self._library_cache_path.__repr__()}, '
             f'library_path={self.library_path.__repr__()}, '
             f'appid={self.appid.__repr__()})'
         )
@@ -42,41 +39,44 @@ class SteamGame(App):
     @property
     def asset_dir(self) -> Path:
         """Returns the path to the game's asset directory."""
-        return Path(self._steam.library_cache).joinpath(self.appid)
+        return self._library_cache_path.joinpath(self.appid)
 
     @property
     def icon(self) -> Path | None:
         """Returns the path to the icon image."""
         if self._icon is None:
-            self._icon = next(
-                (
-                    asset
-                    for asset in self.asset_dir.iterdir()
-                    if asset.is_file() and asset.name not in ASSETS
-                ),
-                None,
-            )
+            try:
+                self._icon = next(
+                    (
+                        asset
+                        for asset in self.asset_dir.iterdir()
+                        if asset.is_file() and asset.name not in ASSETS
+                    ),
+                    None,
+                )
+            except (FileNotFoundError, NotADirectoryError):
+                return None
         return self._icon
 
     @property
     def header(self) -> Path:
         """Returns the path to the header image."""
-        return Path(self._steam.library_cache).joinpath(f'{self.appid}_header.jpg')
+        return self._library_cache_path.joinpath(f'{self.appid}_header.jpg')
 
     @property
     def grid(self) -> Path:
         """Returns the path to the 600x900 grid image."""
-        return Path(self._steam.library_cache).joinpath(f'{self.appid}_library_600x900.jpg')
+        return self._library_cache_path.joinpath(f'{self.appid}_library_600x900.jpg')
 
     @property
     def hero(self) -> Path:
         """Returns the path to the hero image."""
-        return Path(self._steam.library_cache).joinpath(f'{self.appid}_library_hero.jpg')
+        return self._library_cache_path.joinpath(f'{self.appid}_library_hero.jpg')
 
     @property
     def hero_blur(self) -> Path:
         """Returns the path to the blurred hero image."""
-        return Path(self._steam.library_cache).joinpath(f'{self.appid}_library_hero_blur.jpg')
+        return self._library_cache_path.joinpath(f'{self.appid}_library_hero_blur.jpg')
 
     @property
     def manifest_path(self) -> Path:
@@ -115,6 +115,10 @@ class SteamGame(App):
         """Opens the game's store page in the Steam client."""
         self._commands.store(self.appid)
 
+    def install(self):
+        """Installs the game."""
+        self._commands.install(self.appid)
+
     def uninstall(self):
         """Uninstalls the game."""
         self._commands.uninstall(self.appid)

{steam_client-3.0.0.dev0 → steam_client-4.1.0}/steam_client/library.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 import hashlib
-from typing import TYPE_CHECKING, List, Optional, Union
+from typing import TYPE_CHECKING, List, Optional, Union, Generator
 
 import vdf  # type: ignore
 
@@ -8,8 +8,8 @@ from steam_client.shortcut import Shortcut
 
 if TYPE_CHECKING:
     from .steam import Steam
-from .library_directory import LibraryDirectory
-from .game import SteamGame
+from .library_folder import LibraryFolder
+from .game import Game
 
 
 class Library:
@@ -18,7 +18,7 @@ class Library:
     def __init__(self, steam: 'Steam'):
         self._steam = steam
         self._libraries_hash: Optional[str] = None
-        self._libraries: List[LibraryDirectory] = []
+        self._libraries: List[LibraryFolder] = []
 
     def _hash_steam_libraries(self) -> str:
         """Returns the MD5 hash of the Steam library folders file."""
@@ -35,44 +35,46 @@ class Library:
             libraries = vdf.load(f)
         # The is not always formatted the same way, so we grab the first key
         folder_key = list(libraries.keys())[0]
-        self._libraries = [LibraryDirectory(self._steam, libraries[folder_key][item]["path"],
-                                            libraries[folder_key][item]["apps"]) for item in libraries[folder_key]]
+        self._libraries = [LibraryFolder(self._steam.library_cache, libraries[folder_key][item]["path"],
+                                         libraries[folder_key][item]["apps"]) for item in libraries[folder_key]]
 
-    def libraries(self) -> List[LibraryDirectory]:
+    def libraries(self) -> Generator[LibraryFolder, None, None]:
         """Returns the Steam library folders."""
         if self._is_updated():
             self._libraries_hash = self._hash_steam_libraries()
             self._update_libraries()
-        return self._libraries
+        for library in self._libraries:
+            yield library
 
-    def games(self) -> List[SteamGame]:
+    def games(self) -> Generator[Game, None, None]:
         """Returns the games from the Steam library."""
-        games = []
         for library in self.libraries():
-            games.extend(library.get_games())
-        return games
+            for game in library.get_games():
+                yield game
 
-    def game_by_id(self, appid: str) -> Optional[SteamGame]:
+    def game_by_id(self, appid: str) -> Optional[Game]:
         """Returns the game with the specified ID."""
         for game in self.games():
             if game.appid == appid:
                 return game
         return None
 
-    def game_by_name(self, name: str) -> Optional[SteamGame]:
+    def game_by_name(self, name: str) -> Optional[Game]:
         """Returns the game with the specified name."""
         for game in self.games():
             if game.name.casefold() == name.casefold():
                 return game
         return None
 
-    def shortcuts(self) -> List[Shortcut]:
+    def shortcuts(self) -> Generator[Shortcut, None, None]:
         """Returns the Non-Steam shortcuts from the Steam library."""
-        shortcuts = []
         for user in self._steam.users:
-            shortcuts.extend(user.shortcuts())
-        return shortcuts
+            for shortcut in user.shortcuts():
+                yield shortcut
 
-    def all(self) -> List[Union[SteamGame, Shortcut]]:
+    def all(self) -> Generator[Union[Game, Shortcut], None, None]:
         """Returns all the games and shortcuts from the Steam library."""
-        return self.games() + self.shortcuts()
+        for game in self.games():
+            yield game
+        for shortcut in self.shortcuts():
+            yield shortcut

steam_client-4.1.0/steam_client/library_folder.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from pathlib import Path
+from typing import List
+
+from .game import Game
+
+
+@dataclass
+class LibraryFolder:
+    """Represents a Steam library folder."""
+    library_cache_path: Path
+    path: str
+    apps: List[str]
+
+    def get_games(self) -> List[Game]:
+        return [Game(self.library_cache_path, self.path, appid) for appid in self.apps]