steam-client 0.0.1.dev1__tar.gz → 1.0.0.dev0__tar.gz

{steam-client-0.0.1.dev1/steam_client.egg-info → steam-client-1.0.0.dev0}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: steam-client
-Version: 0.0.1.dev1
+Version: 1.0.0.dev0
 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

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ name = "steam-client"
 authors = [
     {name = "William McAllister", email = "dev.garulf@gmail.com"}
 ]
-version = '0.0.1-dev.1'
+version = '1.0.0-dev.0'
 description = "Steam client library for Python"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -16,12 +16,14 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
 ]
+[project.urls]
+Source = "https://github.com/garulf/steam-client"
 
 [tool.setuptools]
 packages = ["steam_client"]
 
 [tool.bumpversion]
-current_version = "0.0.1-dev"
+current_version = "0.0.1-rc.0"
 parse = """(?x)
     (?P<major>[0-9]+)
     \\.(?P<minor>[0-9]+)

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0}/steam_client/login_users.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import List, Optional
 from typing import TYPE_CHECKING
-from typing import TypedDict
 
-import vdf
+import vdf  # type: ignore
 
 if TYPE_CHECKING:
     from steam_client.steam import Steam
@@ -15,7 +14,14 @@ from .shortcut import Shortcut
 STEAM64_OFFSET = 76561197960265728
 
 
-class UserData(TypedDict):
+@dataclass
+class User:
+    id: int
+    data: UserData
+
+
+@dataclass
+class UserData:
     AccountName: str
     PersonaName: str
     RememberPassword: str
@@ -26,29 +32,22 @@ class UserData(TypedDict):
     Timestamp: str
 
 
-UserLoginsFile = Dict[str, Dict[str, UserData]]
-
-
-class User:
+class LoginUser:
     """Represents a current or previous logged in Steam user."""
 
-    def __init__(self, steam: Steam, steam_id64: str, user_data: UserData):
+    def __init__(self, steam: Steam, user: User):
         self._steam = steam
-        self.steam_id64 = steam_id64
-        self._user_data = user_data
-
-    def __repr__(self) -> str:
-        return f'User(steam={self._steam.__repr__()}, steam_id64={self.steam_id64.__repr__()}, user_data={self._user_data.__repr__()})'
+        self.user = user
 
     @property
     def is_most_recent(self) -> bool:
         """Returns whether the user is the most recent user."""
-        return self._user_data['MostRecent'] == '1'
+        return self.user.data.MostRecent == '1'
 
     @property
     def steam_id3(self) -> int:
         """Returns the last portion of the user's SteamID3."""
-        steamidacct = (int(self.steam_id64) - STEAM64_OFFSET)
+        steamidacct = (int(self.user.id) - STEAM64_OFFSET)
         return steamidacct
 
     @property
@@ -89,12 +88,12 @@ class LoginUsers:
         """Returns the path to the loginusers.vdf file."""
         return Path(self._steam.base_path).joinpath('config', 'loginusers.vdf')
 
-    def users(self) -> List[User]:
+    def users(self) -> List[LoginUser]:
         """Returns the users from the loginusers.vdf file."""
         with open(self._path, 'r', encoding='utf-8', errors='ignore') as f:
-            login_users: UserLoginsFile = vdf.load(f)
-        return [User(self._steam, steam_id64, user_data) for steam_id64, user_data in login_users['users'].items()]
+            login_users = vdf.load(f)
+        return [LoginUser(self._steam, User(int(user_id), user_data)) for user_id, user_data in login_users['users'].items()]
 
-    def most_recent_user(self) -> Optional[User]:
+    def most_recent_user(self) -> Optional[LoginUser]:
         """Returns the most recent user from the loginusers.vdf file."""
         return next((user for user in self.users() if user.is_most_recent), None)

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0}/steam_client/shortcut.py

@@ -3,11 +3,11 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Dict
 from typing import TypedDict
 
-import pycrc.algorithms as crc
+import pycrc.algorithms as crc  # type: ignore
 
 if TYPE_CHECKING:
     from .steam import Steam
-    from .login_users import User
+    from .login_users import LoginUser
 
 from .app import App
 
@@ -25,7 +25,7 @@ class ShortcutEntry(TypedDict):
 class Shortcut(App):
     """Represents a Non-Steam Game shortcut."""
 
-    def __init__(self, steam: Steam, user: User, data: ShortcutEntry):
+    def __init__(self, steam: Steam, user: LoginUser, data: ShortcutEntry):
         self._data = data
         self._user = user
         super().__init__(steam)
@@ -54,17 +54,17 @@ class Shortcut(App):
         return str(int(self.appid) >> int(32))
 
     @property
-    def icon(self) -> str:
-        return self._data["icon"] or str(self._user.grid_path.joinpath(f"{self._short_id()}_icon.png"))
+    def icon(self) -> Path:
+        return Path(self._data["icon"]) or self._user.grid_path.joinpath(f"{self._short_id()}_icon.png")
 
     @property
-    def header(self) -> str:
-        return str(self._user.grid_path.joinpath(f"{self._short_id()}.png"))
+    def header(self) -> Path:
+        return self._user.grid_path.joinpath(f"{self._short_id()}.png")
 
     @property
-    def grid(self) -> str:
-        return str(self._user.grid_path.joinpath(f"{self._short_id()}p.png"))
+    def grid(self) -> Path:
+        return self._user.grid_path.joinpath(f"{self._short_id()}p.png")
 
     @property
-    def hero(self) -> str:
-        return str(self._user.grid_path.joinpath(f"{self._short_id()}_hero.png"))
+    def hero(self) -> Path:
+        return self._user.grid_path.joinpath(f"{self._short_id()}_hero.png")

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0}/steam_client/steam.py

@@ -1,4 +1,3 @@
-import functools
 from pathlib import Path
 
 from .library import Library
@@ -13,9 +12,7 @@ class Steam:
 
     def __init__(self, base_path: str = DEFAULT_WIN_STEAM_PATH):
         self.base_path: str = base_path
-        self.login_users = LoginUsers(self)
         self.commands = Commands()
-        self.library = Library(self)
 
     def __repr__(self) -> str:
         return f'Steam(base_path={self.base_path.__repr__()})'
@@ -39,3 +36,11 @@ class Steam:
     def library_cache(self) -> Path:
         """Returns the path to the librarycache folder."""
         return Path(self.base_path).joinpath('appcache', 'librarycache')
+
+    @property
+    def users(self):
+        return LoginUsers(self).users()
+
+    @property
+    def library(self) -> Library:
+        return Library(self)

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0}/steam_client/utils.py

@@ -7,7 +7,12 @@ from .steam import Steam
 STEAM_SUB_KEY = r'SOFTWARE\WOW6432Node\Valve\Steam'
 
 
+def get_steam_from_registry() -> str:
+    """Returns the Steam install path from the Windows registry."""
+    with reg.OpenKey(HKEY_LOCAL_MACHINE, STEAM_SUB_KEY) as hkey:
+        return reg.QueryValueEx(hkey, "InstallPath")[0]
+
+
 def steam_from_registry() -> Steam:
     """Returns a Steam instance from the Windows registry."""
-    with reg.OpenKey(HKEY_LOCAL_MACHINE, STEAM_SUB_KEY) as hkey:
-        return Steam(reg.QueryValueEx(hkey, "InstallPath")[0])
+    return Steam(get_steam_from_registry())

{steam-client-0.0.1.dev1 → steam-client-1.0.0.dev0/steam_client.egg-info}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: steam-client
-Version: 0.0.1.dev1
+Version: 1.0.0.dev0
 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