pyupdator 0.1.0__tar.gz

pyupdator-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: pyupdator
+Version: 0.1.0
+Summary: Delta updater for games (Torrent and HTTP Zip support)
+Author: pyupdator
+License: MIT
+Keywords: delta,updater,game,torrent,http,zip,cdc
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Software Distribution
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: gui
+Requires-Dist: customtkinter>=5.2.0; extra == "gui"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# pyupdator
+
+**Delta updater for games (Torrent and HTTP Zip support).**
+
+`pyupdator` is an independent, pip-installable Python library that lets a game
+launcher (or any host application) update installed game files without
+downloading the entire new release. It supports:
+
+- **BitTorrent piece-level delta** (via `libtorrent`, optional) — download only
+  the missing SHA-1 pieces of a `.torrent`.
+- **HTTP ZIP delta** — read a remote ZIP's Central Directory over HTTP Range
+  requests and download only the changed files.
+- **Content-Defined Chunking (CDC)** via Gear/FastCDC hashing — download only
+  the changed byte ranges of a single HTTP-hosted file.
+
+The library core (`pyupdator/`) contains **no** `tkinter`, `customtkinter`, or
+GUI code. A separate optional package (`pyupdator_gui/`) provides a
+Tkinter/customtkinter launcher window and is installed with
+`pip install pyupdator[gui]`.
+
+## Installation
+
+```bash
+# Library core only (no GUI)
+pip install pyupdator
+
+# Library + optional GUI
+pip install pyupdator[gui]
+```
+
+## Quick start
+
+```python
+from pyupdator import Updater
+
+updater = Updater(install_dir="C:/Oyun", source="oyun.torrent")
+plan = updater.analyze()
+print("Plan:", plan)
+
+updater.update(progress_callback=my_progress_func)
+
+# Optional verification
+result = updater.verify()
+print("Verified:", result)
+```
+
+See `examples/basic_usage.py` for a complete GUI-free example.
+
+## Project layout
+
+```
+pyupdator/            # library core (no GUI imports)
+  __init__.py         # public API: Updater, UpdaterError, logging helpers
+  core/
+    __init__.py
+    torrent.py        # .torrent parse, recheck, delta plan, apply, verify
+    zip_engine.py     # HTTP ZIP delta + CDC chunker
+    backend_manager.py# download backend detection & selection
+  utils/
+    __init__.py
+    helpers.py        # UpdaterError, hashing, safe_join, config, ...
+pyupdator_gui/        # optional Tkinter/customtkinter GUI
+  __init__.py
+  main_window.py      # MainWindow ported from gui.py
+examples/
+  basic_usage.py      # GUI-free usage example
+tests/                # existing test suite moved here
+pyproject.toml
+README.md
+```
+
+## Updater API contract
+
+```python
+from pyupdator import Updater
+
+updater = Updater(install_dir="C:/Oyun", source="oyun.torrent")
+plan = updater.analyze()          # returns a plan dict
+updater.update(progress_callback=my_func)   # applies the update
+updater.verify()                  # verifies installed files against source
+```
+
+## Logging
+
+`pyupdator` uses the standard `logging` module (logger name `"pyupdator"`).
+The host launcher can forward logs to its own console or GUI:
+
+```python
+import logging
+from pyupdator import add_log_handler, set_log_level
+
+handler = logging.StreamHandler()
+add_log_handler(handler)
+set_log_level(logging.DEBUG)
+```
+
+## Backends
+
+| Backend      | Capability     | Notes                              |
+|--------------|----------------|------------------------------------|
+| libtorrent   | PIECE_LEVEL    | Optional; true piece-level delta   |
+| aria2        | FILE_LEVEL     | aria2c JSON-RPC                    |
+| qBittorrent  | FILE_LEVEL     | Web API v2                         |
+| uTorrent     | FILE_LEVEL     | Web UI, best effort                |
+| Transmission | FILE_LEVEL     | RPC                                |
+| manual       | FILE_LEVEL     | Manual/local source                |
+| http_zip     | CHUNK_LEVEL    | HTTP ZIP delta / CDC               |
+
+`libtorrent` is often unavailable on Windows + Python 3.13; the library falls
+back to FILE_LEVEL backends and reports this clearly.
+
+## Tests
+
+Run the test suite:
+
+```bash
+python -m pytest tests/
+```
+
+Individual test scripts can also be run directly:
+
+```bash
+python tests/test_cdc_delta.py
+python tests/test_zip_delta.py
+```
+
+## PyPI publishing
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+If a PyPI token is required, set `TWINE_USERNAME` and `TWINE_PASSWORD` (or use
+`~/.pypirc`). If `twine upload` returns `400 Bad Request` because the name
+`pyupdator` collides with an existing package (e.g. `pyupdater`), rename the
+project in `pyproject.toml` and republish.

pyupdator-0.1.0/README.md

@@ -0,0 +1,138 @@
+# pyupdator
+
+**Delta updater for games (Torrent and HTTP Zip support).**
+
+`pyupdator` is an independent, pip-installable Python library that lets a game
+launcher (or any host application) update installed game files without
+downloading the entire new release. It supports:
+
+- **BitTorrent piece-level delta** (via `libtorrent`, optional) — download only
+  the missing SHA-1 pieces of a `.torrent`.
+- **HTTP ZIP delta** — read a remote ZIP's Central Directory over HTTP Range
+  requests and download only the changed files.
+- **Content-Defined Chunking (CDC)** via Gear/FastCDC hashing — download only
+  the changed byte ranges of a single HTTP-hosted file.
+
+The library core (`pyupdator/`) contains **no** `tkinter`, `customtkinter`, or
+GUI code. A separate optional package (`pyupdator_gui/`) provides a
+Tkinter/customtkinter launcher window and is installed with
+`pip install pyupdator[gui]`.
+
+## Installation
+
+```bash
+# Library core only (no GUI)
+pip install pyupdator
+
+# Library + optional GUI
+pip install pyupdator[gui]
+```
+
+## Quick start
+
+```python
+from pyupdator import Updater
+
+updater = Updater(install_dir="C:/Oyun", source="oyun.torrent")
+plan = updater.analyze()
+print("Plan:", plan)
+
+updater.update(progress_callback=my_progress_func)
+
+# Optional verification
+result = updater.verify()
+print("Verified:", result)
+```
+
+See `examples/basic_usage.py` for a complete GUI-free example.
+
+## Project layout
+
+```
+pyupdator/            # library core (no GUI imports)
+  __init__.py         # public API: Updater, UpdaterError, logging helpers
+  core/
+    __init__.py
+    torrent.py        # .torrent parse, recheck, delta plan, apply, verify
+    zip_engine.py     # HTTP ZIP delta + CDC chunker
+    backend_manager.py# download backend detection & selection
+  utils/
+    __init__.py
+    helpers.py        # UpdaterError, hashing, safe_join, config, ...
+pyupdator_gui/        # optional Tkinter/customtkinter GUI
+  __init__.py
+  main_window.py      # MainWindow ported from gui.py
+examples/
+  basic_usage.py      # GUI-free usage example
+tests/                # existing test suite moved here
+pyproject.toml
+README.md
+```
+
+## Updater API contract
+
+```python
+from pyupdator import Updater
+
+updater = Updater(install_dir="C:/Oyun", source="oyun.torrent")
+plan = updater.analyze()          # returns a plan dict
+updater.update(progress_callback=my_func)   # applies the update
+updater.verify()                  # verifies installed files against source
+```
+
+## Logging
+
+`pyupdator` uses the standard `logging` module (logger name `"pyupdator"`).
+The host launcher can forward logs to its own console or GUI:
+
+```python
+import logging
+from pyupdator import add_log_handler, set_log_level
+
+handler = logging.StreamHandler()
+add_log_handler(handler)
+set_log_level(logging.DEBUG)
+```
+
+## Backends
+
+| Backend      | Capability     | Notes                              |
+|--------------|----------------|------------------------------------|
+| libtorrent   | PIECE_LEVEL    | Optional; true piece-level delta   |
+| aria2        | FILE_LEVEL     | aria2c JSON-RPC                    |
+| qBittorrent  | FILE_LEVEL     | Web API v2                         |
+| uTorrent     | FILE_LEVEL     | Web UI, best effort                |
+| Transmission | FILE_LEVEL     | RPC                                |
+| manual       | FILE_LEVEL     | Manual/local source                |
+| http_zip     | CHUNK_LEVEL    | HTTP ZIP delta / CDC               |
+
+`libtorrent` is often unavailable on Windows + Python 3.13; the library falls
+back to FILE_LEVEL backends and reports this clearly.
+
+## Tests
+
+Run the test suite:
+
+```bash
+python -m pytest tests/
+```
+
+Individual test scripts can also be run directly:
+
+```bash
+python tests/test_cdc_delta.py
+python tests/test_zip_delta.py
+```
+
+## PyPI publishing
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+If a PyPI token is required, set `TWINE_USERNAME` and `TWINE_PASSWORD` (or use
+`~/.pypirc`). If `twine upload` returns `400 Bad Request` because the name
+`pyupdator` collides with an existing package (e.g. `pyupdater`), rename the
+project in `pyproject.toml` and republish.

pyupdator-0.1.0/examples/basic_usage.py

@@ -0,0 +1,66 @@
+"""
+examples/basic_usage.py — GUI-free example showing how to use pyupdator.
+
+This is the canonical example for a game launcher or other host project.
+
+    pip install pyupdator
+
+Usage:
+    python examples/basic_usage.py
+"""
+
+from __future__ import annotations
+
+import logging
+import sys
+from pathlib import Path
+
+# Ensure the local pyupdator package is importable when running from the repo.
+sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
+
+from pyupdator import Updater, UpdaterError, human_bytes
+
+
+def progress_callback(done: int, total: int, message: str = "") -> None:
+    """Host-provided progress callback."""
+    if total:
+        pct = done / total * 100
+        print(f"[{pct:6.2f}%] {message}  ({human_bytes(done)} / {human_bytes(total)})")
+    else:
+        print(f"{message}  ({human_bytes(done)})")
+
+
+def main() -> int:
+    logging.basicConfig(
+        level=logging.INFO,
+        format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+    )
+
+    # The host launcher decides install_dir and source.
+    install_dir = Path("C:/Oyun")  # <-- change to your game folder
+    source = "oyun.torrent"        # <-- change to your .torrent or HTTP URL
+
+    try:
+        updater = Updater(install_dir=str(install_dir), source=source)
+
+        # 1) Analyze what needs to be downloaded / verified.
+        plan = updater.analyze()
+        print("Analiz tamamlandı. Plan:", plan)
+
+        # 2) Apply the update, reporting progress back to the host.
+        updater.update(progress_callback=progress_callback)
+        print("Güncelleme tamamlandı.")
+
+        # 3) (Optional) verify the installed files against the torrent.
+        result = updater.verify()
+        print("Doğrulama sonucu:", result)
+
+    except UpdaterError as exc:
+        print(f"Hata: {exc}", file=sys.stderr)
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pyupdator-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyupdator"
+version = "0.1.0"
+description = "Delta updater for games (Torrent and HTTP Zip support)"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [{name = "pyupdator"}]
+keywords = ["delta", "updater", "game", "torrent", "http", "zip", "cdc"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Software Distribution",
+    "Topic :: Utilities",
+]
+
+# Optional dependencies — GUI requires customtkinter.
+[project.optional-dependencies]
+gui = ["customtkinter>=5.2.0"]
+dev = [
+    "pytest>=7.0",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+pyupdator-gui = "pyupdator_gui.__init__:run"
+
+[tool.setuptools.packages.find]
+include = ["pyupdator*", "pyupdator_gui*", "examples*", "tests*"]
+
+[tool.setuptools.package-data]
+pyupdator = ["*.json", "*.cfg"]
+pyupdator_gui = ["*.json"]
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+
+[tool.ruff]
+line-length = 100