steam-cloud-backup 0.1.1__tar.gz → 0.1.2__tar.gz

{steam_cloud_backup-0.1.1/steam_cloud_backup.egg-info → steam_cloud_backup-0.1.2}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.4
 Name: steam-cloud-backup
-Version: 0.1.1
+Version: 0.1.2
 Summary: micro-script for downloading all save files from steam cloud
 Author: q-deltaftactal
 License-Expression: MIT
-Project-URL: Repository, https://github.com/q-deltafractal/steam-cloud-backup.git
-Project-URL: Issues, https://github.com/q-deltafractal/steam-cloud-backup/issues
-Classifier: Topic :: Utilities
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
 License-File: LICENSE
+Classifier: Topic :: Utilities
 Requires-Dist: aiofiles>=25.1.0
 Requires-Dist: aiohttp[speedups]>=3.14.1
-Dynamic: license-file
+Requires-Python: >=3.14
+Project-URL: Repository, https://github.com/q-deltafractal/steam-cloud-backup.git
+Project-URL: Issues, https://github.com/q-deltafractal/steam-cloud-backup/issues
+Description-Content-Type: text/markdown
 
 # steam-cloud-backup
 
@@ -20,6 +19,20 @@ micro-script for downloading all save files from [steam cloud](https://store.ste
 
 <br>
 
+## installation
+
+from (PyPI)[https://pypi.org/project/steam-cloud-backup/]:
+
+```bash
+# with pip
+pip install steam-cloud-backup
+```
+
+```bash
+# or pipx
+pipx install steam-cloud-backup
+```
+
 ## backup process
 
 ### requirements

{steam_cloud_backup-0.1.1 → steam_cloud_backup-0.1.2}/README.md

@@ -4,6 +4,20 @@ micro-script for downloading all save files from [steam cloud](https://store.ste
 
 <br>
 
+## installation
+
+from (PyPI)[https://pypi.org/project/steam-cloud-backup/]:
+
+```bash
+# with pip
+pip install steam-cloud-backup
+```
+
+```bash
+# or pipx
+pipx install steam-cloud-backup
+```
+
 ## backup process
 
 ### requirements

{steam_cloud_backup-0.1.1 → steam_cloud_backup-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "steam-cloud-backup"
-version = "0.1.1"
+version = "0.1.2"
 authors = [
 	{ name="q-deltaftactal" }
 ]
@@ -21,8 +21,19 @@ dependencies = [
 Repository = "https://github.com/q-deltafractal/steam-cloud-backup.git"
 Issues = "https://github.com/q-deltafractal/steam-cloud-backup/issues"
 
+[project.scripts]
+scb-cli = 'steam-cloud-backup.cli:main'
+
+[build-system]
+requires = ["uv_build>=0.11.28,<0.12"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "source"
+module-root = ""
+
 [tool.setuptools]
-py-modules = ['source']
+packages = ['source']
 
 [tool.ruff.format]
 quote-style = "single"

steam_cloud_backup-0.1.2/source/cli.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+
+__all__ = ()
+
+import logging
+import asyncio
+import argparse
+from pathlib import Path
+
+from source.errors import BadSessionException, ZeroAnswerException
+from source.lib import SESSION_ID, STEAM_LOGIN_SECURE, parse
+
+
+# connection
+DEFAULT_USER_AGENT = (
+    'Mozilla/5.0 (Windows NT 10.0; Win64; x64) '
+    'AppleWebKit/537.36 (KHTML, like Gecko) '
+    'Chrome/150.0.0.0 Safari/537.36'
+)
+
+
+class _ArgumentParser(argparse.ArgumentParser):
+    def _print_message(self, message: str, file=None) -> None:
+        super()._print_message(f'\n{message}\n', file=file)
+
+
+def main() -> None:
+    parser = _ArgumentParser(
+        prog='steam-cloud-backup',
+        description='micro-script for downloading all save files from steam cloud',
+    )
+
+    # session group
+    group = parser.add_argument_group('session')
+    group.add_argument(
+        '-i',
+        f'--{SESSION_ID}',
+        type=str,
+    )
+    group.add_argument(
+        '-l',
+        f'--{STEAM_LOGIN_SECURE}',
+        type=str,
+    )
+
+    # connection group
+    group = parser.add_argument_group('connection')
+    group.add_argument(
+        '-j',
+        '--max-concurrent-connections',
+        default=16,
+        help='default: 16',
+        type=int,
+    )
+    group.add_argument(
+        '--connect-timeout',
+        default=60,
+        help='default: 60 (s)',
+        type=int,
+    )
+    group.add_argument(
+        '--useragent',
+        default=DEFAULT_USER_AGENT,
+        type=str,
+    )
+
+    # out group
+    group = parser.add_argument_group('out')
+    group.add_argument('folder', type=Path)
+    group.add_argument(
+        '-v',
+        '--verbose',
+        choices=(0, 1, 2),
+        default=1,
+        help="""logging type:
+0 - off;
+1 (default) - info;
+2 - debug""",
+        type=int,
+    )
+
+    args = parser.parse_args()
+    del group
+
+    # data
+    try:
+        for k in (STEAM_LOGIN_SECURE,):
+            attr = getattr(args, k)
+            if not attr:
+                if not (value := input(f'{k}: ')):
+                    raise
+                setattr(args, k, value)
+    except Exception, KeyboardInterrupt:
+        parser.exit(1, '\nnot enough data\n')
+
+    logging_level: int | None
+    match args.verbose:
+        case 0:
+            logging_level = None
+        case 1:
+            logging_level = logging.INFO
+        case 2:
+            logging_level = logging.DEBUG
+
+    logging.basicConfig(level=logging_level)
+
+    # parser
+    try:
+        asyncio.run(
+            parse(
+                c_session_id=getattr(args, SESSION_ID),
+                c_steam_login_secure=getattr(args, STEAM_LOGIN_SECURE),
+                concurrent_connections=args.max_concurrent_connections,
+                connect_timeout=args.connect_timeout,
+                path_to_folder=args.folder,
+                useragent=args.useragent,
+            )
+        )
+    except BadSessionException:
+        parser.exit(2, 'bad cookie session\n')
+    except ZeroAnswerException:
+        parser.exit(3, 'steam return zero page\n')
+    except KeyboardInterrupt:
+        parser.exit(4, 'user kill task')
+
+
+if __name__ == '__main__':
+    main()

steam_cloud_backup-0.1.2/source/errors.py

@@ -0,0 +1,23 @@
+__all__ = (
+    'ParserException',
+    'BadSessionException',
+    'ZeroAnswerException',
+    'DownloadException',
+)
+
+from pathlib import Path
+
+
+class ParserException(Exception): ...
+
+
+class BadSessionException(ParserException): ...
+
+
+class ZeroAnswerException(ParserException): ...
+
+
+class DownloadException(ParserException):
+    def __init__(self, path: Path) -> None:
+        super().__init__()
+        self.path = path

steam_cloud_backup-0.1.2/source/lib.py

@@ -0,0 +1,135 @@
+__all__ = ('parse',)
+
+import math
+import random
+import string
+import logging
+import asyncio
+from pathlib import Path
+
+import aiofiles
+import aiohttp
+from aiohttp import TCPConnector
+
+from source.tools import TableParser
+from source.errors import BadSessionException, DownloadException, ZeroAnswerException
+
+
+# datalink
+REMOTE_STORAGE_URL = 'https://store.steampowered.com/account/remotestorage'
+
+# cookie key names
+SESSION_ID = 'sessionId'
+STEAM_LOGIN_SECURE = 'steamLoginSecure'
+
+# max rows per page
+STEAM_PER_PAGE = 50
+
+# logging
+logger = logging.getLogger(__name__)
+
+
+async def parse(
+    c_steam_login_secure: str,
+    path_to_folder: Path,
+    useragent: str,
+    concurrent_connections: int,
+    connect_timeout: int,
+    c_session_id: str | None = None,
+) -> None:
+    if c_session_id is None:
+        # steam default `sessionId` scheme
+        c_session_id = ''.join(
+            random.choices(string.ascii_lowercase + string.digits, k=24)
+        )
+
+    async with aiohttp.ClientSession(
+        connector=TCPConnector(limit=concurrent_connections, ttl_dns_cache=300),
+        timeout=aiohttp.ClientTimeout(total=connect_timeout),
+        headers={
+            'User-Agent': useragent,
+        },
+        cookies={
+            SESSION_ID: c_session_id,
+            STEAM_LOGIN_SECURE: c_steam_login_secure,
+        },
+        cookie_jar=aiohttp.CookieJar(),
+    ) as session:
+        text: str
+        async with session.get(url=REMOTE_STORAGE_URL) as r:
+            logger.debug('%s', str(r))
+
+            if not r.ok:
+                raise BadSessionException
+            text = await r.text()
+
+        if 'g_AccountID = 0;' in text:
+            raise BadSessionException
+
+        g_parser = TableParser()
+        g_parser.feed(text)
+
+        path_to_folder.mkdir(parents=True, exist_ok=True)
+
+        if not (games_table := g_parser.rows):
+            raise ZeroAnswerException
+        #                 / size
+        for name, rows_c, _, g_url in games_table:
+            logger.info('iter game: %s; files count: %s', name, rows_c)
+
+            game_path = path_to_folder / name
+
+            for page in range(math.ceil(int(rows_c) / STEAM_PER_PAGE)):
+                params = {'index': page * STEAM_PER_PAGE} if page else None
+
+                first_iter = True
+                bad_files: set[Path] = set()
+                while first_iter or bad_files:
+                    logger.debug('%s', str(bad_files))
+                    try:
+                        l_parser: TableParser
+                        async with session.get(url=g_url, params=params) as dr:
+                            l_parser = TableParser()
+                            l_parser.feed(await dr.text())
+
+                        async with asyncio.TaskGroup() as task_g:
+                            #                            / date written
+                            for folder, file_name, size, _, l_url in l_parser.rows:
+                                file_path = game_path / folder / file_name
+                                if first_iter or (
+                                    file_path in bad_files
+                                    and bad_files.remove(file_path)
+                                    is None  # deleting file_name in bad_files if find
+                                ):
+                                    file_path.parent.mkdir(parents=True, exist_ok=True)
+                                    task_g.create_task(
+                                        download_file(session, l_url, file_path, size)
+                                    )
+                    except* DownloadException as errs:
+                        for e in errs.exceptions:
+                            bad_files.add(e.path)
+                    except* Exception:
+                        await asyncio.sleep(1)
+
+                    first_iter = False
+
+
+async def download_file(
+    session: aiohttp.ClientSession,
+    url: str,
+    path: Path,
+    size: str,
+    chunk_size: int = 8_192,
+) -> None:
+    try:
+        async with session.get(url=url) as r:
+            r.raise_for_status()
+
+            async with aiofiles.open(path, 'wb') as f:
+                logger.info('download file %s; size: %s', path, size)
+                async for chunk in r.content.iter_chunked(chunk_size):
+                    await f.write(chunk)
+
+    except Exception as err:
+        logger.debug('%s: %s', type(err), str(err))
+        raise DownloadException(path)

steam_cloud_backup-0.1.2/source/tools.py

@@ -0,0 +1,73 @@
+__all__ = ('TableParser',)
+
+import io
+from html.parser import HTMLParser
+
+
+class _CellIO(io.StringIO):
+    """override io.StringIO with write blocking"""
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+
+        self.shadow_close = False
+
+    def write(self, *args, **kwargs) -> int:
+        if not self.shadow_close:
+            return super().write(*args, **kwargs)
+        return -1
+
+
+class TableParser(HTMLParser):
+    """parse steam backend table in py objects"""
+
+    _current_row: list[str]
+    _cell_buf: _CellIO
+
+    def __init__(self) -> None:
+        super().__init__()
+
+        self._in_tr = False
+        self._in_td = False
+
+        self.rows: list[tuple[str, ...]] = []
+
+    def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None:
+        tag = tag.lower()
+
+        if tag == 'tr':
+            self._in_tr = True
+            self._current_row = []
+        elif self._in_tr and tag == 'td':
+            self._in_td = True
+            self._cell_buf = _CellIO()
+        elif tag == 'a':
+            #                   `href=` attr
+            self._cell_buf.write(attrs[0][1])
+            self._cell_buf.shadow_close = True
+
+    def handle_endtag(self, tag: str) -> None:
+        tag = tag.lower()
+
+        if tag == 'tr':
+            if self._current_row:
+                self.rows.append(tuple(self._current_row))
+            self._in_tr = False
+        if self._in_tr and tag == 'td':
+            self._cell_buf.seek(0)
+            cell = self._cell_buf.read().strip()
+            #                       void is not a correct folder name
+            self._current_row.append(cell if cell else '_')
+
+            self._in_td = False
+
+    def handle_data(self, data: str) -> None:
+        if self._in_tr and self._in_td:
+            self._cell_buf.write(data)
+
+    def feed(self, html: str, *args, **kwargs) -> None:
+        super().feed(
+            html[html.index('<tbody>') + 7 : html.rindex('</tbody>')].strip(),
+            *args,
+            **kwargs,
+        )

steam_cloud_backup-0.1.1/PKG-INFO

@@ -1,116 +0,0 @@
-Metadata-Version: 2.4
-Name: steam-cloud-backup
-Version: 0.1.1
-Summary: micro-script for downloading all save files from steam cloud
-Author: q-deltaftactal
-License-Expression: MIT
-Project-URL: Repository, https://github.com/q-deltafractal/steam-cloud-backup.git
-Project-URL: Issues, https://github.com/q-deltafractal/steam-cloud-backup/issues
-Classifier: Topic :: Utilities
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aiofiles>=25.1.0
-Requires-Dist: aiohttp[speedups]>=3.14.1
-Dynamic: license-file
-
-# steam-cloud-backup
-
-micro-script for downloading all save files from [steam cloud](https://store.steampowered.com/account/remotestorage)
-
-<br>
-
-## backup process
-
-### requirements
-
-- [ ] [uv](https://docs.astral.sh/uv/) python package manager
-- [ ] [git](https://git-scm.com/install/) version control
-
-_latest versions_
-
-### preparation
-
-```bash
-# clone repo
-git clone https://github.com/q-deltafractal/steam-cloud-backup.git
-cd steam-cloud-backup
-```
-
-```bash
-# setup virtual env
-uv sync
-```
-
-### backup
-
-```console
-$ uv run main.py backup-folder/
-steamLoginSecure: <input>
-INFO:__main__:iter game: Steam Client; files count: 2
-...
-```
-
-<br>
-
-To identify login to your account, steam uses `steamLoginSecure` cookie, therefore the script requires it to work.  
-Method of obtaining this cookie:
-
-- [ ] log in to https://store.steampowered.com/login/
-- [ ] open Dev Tools via `ctrl + shift + i`
-- [ ] go to the application _(or storage)_ tab
-- [ ] in the cookies section, select `https://store.steampowered.com`
-- [ ] copy the entire contents of the `steamLoginSecure` column
-
-<br>
-
-## usage
-
-```console block=api
-usage: steam-cloud-backup [-h] [-i SESSIONID] [-l STEAMLOGINSECURE]
-                          [-j MAX_CONCURRENT_CONNECTIONS]
-                          [--connect-timeout CONNECT_TIMEOUT]
-                          [--useragent USERAGENT] [-v (0, 1, 2)]
-                          folder
-
-micro-script for downloading all save files from steam cloud
-
-options:
-  -h, --help            show this help message and exit
-
-session:
-  -i, --sessionId SESSIONID
-  -l, --steamLoginSecure STEAMLOGINSECURE
-
-connection:
-  -j, --max-concurrent-connections MAX_CONCURRENT_CONNECTIONS
-                        default: 16
-  --connect-timeout CONNECT_TIMEOUT
-                        default: 60 (s)
-  --useragent USERAGENT
-
-out:
-  folder
-  -v, --verbose (0, 1, 2)
-                        logging type: 0 - off; 1 (default) - info; 2 - debug
-```
-
-<br>
-
-## license
-
-project is licensed under:
-
-<table>
-  <tr>
-    <td>
-      MIT
-    </td>
-    <td>
-      <a href="LICENSE">LICENSE</a>
-    </td>
-    <td>
-      https://mit-license.org/
-    </td>
-  </tr>
-</table>

steam_cloud_backup-0.1.1/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

steam_cloud_backup-0.1.1/steam_cloud_backup.egg-info/SOURCES.txt

@@ -1,8 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-steam_cloud_backup.egg-info/PKG-INFO
-steam_cloud_backup.egg-info/SOURCES.txt
-steam_cloud_backup.egg-info/dependency_links.txt
-steam_cloud_backup.egg-info/requires.txt
-steam_cloud_backup.egg-info/top_level.txt

steam_cloud_backup-0.1.1/steam_cloud_backup.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

steam_cloud_backup-0.1.1/steam_cloud_backup.egg-info/requires.txt

@@ -1,2 +0,0 @@
-aiofiles>=25.1.0
-aiohttp[speedups]>=3.14.1

steam_cloud_backup-0.1.1/steam_cloud_backup.egg-info/top_level.txt

@@ -1 +0,0 @@
-source