steam-client 2.0.0.dev0__tar.gz → 2.1.0.dev0__tar.gz

{steam-client-2.0.0.dev0/steam_client.egg-info → steam-client-2.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: steam-client
-Version: 2.0.0.dev0
+Version: 2.1.0.dev0
 Summary: Steam client library for Python
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT

{steam-client-2.0.0.dev0 → steam-client-2.1.0.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ name = "steam-client"
 authors = [
     {name = "William McAllister", email = "dev.garulf@gmail.com"}
 ]
-version = '2.0.0-dev.0'
+version = "2.1.0-dev.0"
 description = "Steam client library for Python"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -31,7 +31,7 @@ packages = ["steam_client"]
 "steam_client" = ["py.typed"]
 
 [tool.bumpversion]
-current_version = "1.0.1-dev.0"
+current_version = "2.0.1-dev.0"
 parse = """(?x)
     (?P<major>[0-9]+)
     \\.(?P<minor>[0-9]+)

{steam-client-2.0.0.dev0 → steam-client-2.1.0.dev0}/steam_client/app.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 
-from .commands import run_game_id
+from .commands import Commands 
 
 if TYPE_CHECKING:
     from .steam import Steam
@@ -15,6 +15,13 @@ class App(ABC):
 
     def __init__(self, steam: Steam):
         self._steam = steam
+        self._commands = Commands()
+
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """Returns the app's name."""
+        pass
 
     @property
     @abstractmethod
@@ -45,4 +52,4 @@ class App(ABC):
 
     def run(self):
         """Launches app with the specified app ID in the Steam client."""
-        self._steam.command(run_game_id(self.appid))
+        self._commands.run_game_id(self.appid)

steam-client-2.1.0.dev0/steam_client/commands.py

@@ -0,0 +1,69 @@
+from typing import List
+import webbrowser
+from enum import StrEnum
+
+SCHEME = 'steam'
+
+class SteamWindows(StrEnum):
+    """Enumeration of Steam client windows."""
+    MAIN = 'main'
+    GAMES = 'games'
+    GAMES_DETAILS = 'games/details'
+    GAMES_GRID = 'games/grid'
+    GAMES_LIST = 'games/list'
+    FRIENDS = 'friends'
+    CHAT = 'chat'
+    BIGPICTURE = 'bigpicture'
+    NEWS = 'news'
+    SETTINGS = 'settings'
+    TOOLS = 'tools'
+    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 run_game_id(self, app_id: str) -> str:
+        """Launches game with the specified ID in the Steam client."""
+        self._command(['rungameid'], app_id)
+
+    def store(self, app_id: str) -> str:
+        """Opens the game's store page in the Steam client."""
+        self._command(['store'], app_id)
+
+    def install(self, app_id: str) -> str:
+        """Opens the game's install prompt in the Steam client."""
+        self._command(['install'], app_id)
+
+    def uninstall(self, app_id: str) -> str:
+        """Opens the game's uninstall prompt in the Steam client."""
+        self._command(['uninstall'], app_id)
+
+    def update_news(self, app_id: str) -> str:
+        """Opens the game's update news in the Steam client."""
+        self._command(['updatenews'], app_id)
+
+    def open(self, window: SteamWindows) -> str:
+        """Opens the specified window in the Steam client."""
+        self._command(['open'], window)
+
+    def open_url(self, url: str) -> str:
+        """Opens the specified URL in the Steam client."""
+        self._command(['openurl'], url)
+
+

{steam-client-2.0.0.dev0 → steam-client-2.1.0.dev0}/steam_client/game.py

@@ -13,6 +13,14 @@ from .app import App
 
 UNKNOWN_GAME_NAME = 'UNKNOWN'
 
+ASSETS = [
+    "header.jpg",
+    "library_600x900.jpg",
+    "library_hero.jpg",
+    "library_hero_blur.jpg",
+    "logo.png"
+]
+
 
 class SteamGame(App):
     """Represents a Steam game."""
@@ -25,9 +33,17 @@ class SteamGame(App):
     def __repr__(self) -> str:
         return f'Game(steam={self._steam.__repr__()}, library_path={self.library_path.__repr__()}, appid={self.appid.__repr__()})'
 
+    @property
+    def asset_dir(self) -> Path:
+        """Returns the path to the game's asset directory."""
+        return Path(self._steam.library_cache).joinpath(self.appid)
+
     @property
     def icon(self) -> Path:
         """Returns the path to the icon image."""
+        for asset in self.asset_dir.iterdir():
+            if asset.name not in ASSETS:
+                return asset
         return Path(self._steam.library_cache).joinpath(f'{self.appid}_icon.jpg')
 
     @property

{steam-client-2.0.0.dev0 → steam-client-2.1.0.dev0}/steam_client/steam.py

@@ -4,13 +4,14 @@ import webbrowser
 from .library import Library
 from .login_users import LoginUsers
 
-DEFAULT_WIN_STEAM_PATH = r"c:\Program Files (x86)\Steam"
+WIN_STEAM_PATH = r"c:\Program Files (x86)\Steam"
+LINUX_STEAM_PATH = "~/.local/share/steam"
 
 
 class Steam:
     """Represents the Steam client."""
 
-    def __init__(self, base_path: str = DEFAULT_WIN_STEAM_PATH):
+    def __init__(self, base_path: str = WIN_STEAM_PATH):
         self.base_path: str = base_path
 
     def __repr__(self) -> str:

{steam-client-2.0.0.dev0 → steam-client-2.1.0.dev0/steam_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: steam-client
-Version: 2.0.0.dev0
+Version: 2.1.0.dev0
 Summary: Steam client library for Python
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT

steam-client-2.0.0.dev0/steam_client/commands.py

@@ -1,52 +0,0 @@
-from typing import Literal
-
-
-SteamWindow = Literal[
-    'main',
-    'games',
-    'games/details',
-    'games/grid',
-    'games/list',
-    'friends',
-    'chat',
-    'bigpicture',
-    'news',
-    'settings',
-    'tools',
-    'console'
-]
-
-
-def run_game_id(app_id: str) -> str:
-    """Launches game with the specified ID in the Steam client."""
-    return f'steam://rungameid/{app_id}'
-
-
-def store(app_id: str) -> str:
-    """Opens the game's store page in the Steam client."""
-    return f'steam://store/{app_id}'
-
-
-def install(app_id: str) -> str:
-    """Opens the game's install prompt in the Steam client."""
-    return 'steam://install/{app_id}'
-
-
-def uninstall(app_id: str) -> str:
-    """Opens the game's uninstall prompt in the Steam client."""
-    return f'steam://uninstall/{app_id}'
-
-
-def update_news(app_id: str) -> str:
-    """Opens the game's update news in the Steam client."""
-    return f'steam://updatenews/{app_id}'
-
-
-def open(window: SteamWindow) -> str:
-    """Opens the specified window in the Steam client."""
-    return f'steam://open/{window}'
-
-
-def open_url(url: str) -> str:
-    """Opens the specified URL in the Steam client."""
-    return f'steam://openurl/{url}'