pyappxportable 2026.11.1__tar.gz

pyappxportable-2026.11.1/.gitignore

@@ -0,0 +1,181 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

pyappxportable-2026.11.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 yell0wsuit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyappxportable-2026.11.1/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.5
+Name: pyappxportable
+Version: 2026.11.1
+Summary: Install Windows Store game packages as portable Appx Portable games.
+Project-URL: Homepage, https://github.com/yell0wsuit/pyappxportable
+Project-URL: Issues, https://github.com/yell0wsuit/pyappxportable/issues
+Project-URL: Runtime, https://github.com/yell0wsuit/appx-portable
+Author: yell0wsuit
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: packaging>=20
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyappxportable
+
+Install Windows Store games as ordinary portable desktop games using [Appx Portable](https://github.com/yell0wsuit/appx-portable).
+
+Give the installer an `.appxbundle`, `.appx`, or extracted package folder. It extracts the game, downloads the matching Appx Portable runtime and required Microsoft framework packages, applies supported game patches, and writes a `00_click2startme` launcher. Updates preserve saves, settings, and logs.
+
+This package contains no games or Microsoft runtime files. Supply your own game packages. Runtime DLLs and game patches come from `yell0wsuit/appx-portable`; framework packages come from `yell0wsuit/vclibs-appx` with pinned SHA-256 checks.
+
+## Install
+
+Requires **Python 3.8 or later**, with pip. Use a Python release compatible with your Windows version; managed XAML games need Windows 10 1903 or later and .NET Framework 4.x. macOS/Wine support is experimental; managed games and games that require the native host need Windows.
+
+```sh
+python -m pip install pyappxportable
+pyappxportable "C:\Downloads\Game.appxbundle"
+```
+
+On Windows, `py -m pip` and `py -m pyappxportable` also work. On macOS/Linux, use `python3` if that is your Python command. With a Python installation managed by your OS, install into a virtual environment or use `pipx install pyappxportable`.
+
+Run `pyappxportable` without arguments for prompts. If the command is not on your PATH, use `python -m pyappxportable`. After installation, double-click `00_click2startme.bat` on Windows or `00_click2startme.command` on macOS. Linux uses `00_click2startme.sh` with Wine.
+
+## Command-line options
+
+```sh
+pyappxportable Game.appx --dest Games/Game --store none --launcher --yes
+python -m pyappxportable --help
+```
+
+| Option                           | Purpose                                                         |
+| -------------------------------- | --------------------------------------------------------------- |
+| `--version` | Show the installed pyappxportable version |
+| `--no-update-check` | Skip the background PyPI update check |
+| `--dest FOLDER`                  | Destination; defaults beside the source, using its package name |
+| `--dependencies PATH`            | VCLibs or .NET Native package/folder; repeat for several        |
+| `--build FOLDER`                 | Use locally built runtime DLLs                                  |
+| `--release TAG`                  | Select a runtime release instead of the latest                  |
+| `--store none\|trial\|iap\|both` | Store overrides; omitted with `--yes` preserves settings        |
+| `--launcher`, `--no-launcher`    | Create or skip the launcher; defaults to creating it            |
+| `--no-patch`                     | Skip known-game patches                                         |
+| `--patch-dir FOLDER`             | Use a local Appx Portable `patch/` folder                       |
+| `--desktop-copy`                 | Make a Windows 8/8.1 desktop executable copy on any Windows     |
+| `--yes`                          | Disable prompts; fail if a required input is missing            |
+
+For a local runtime checkout:
+
+```sh
+pyappxportable Game.appx --build ../appx-portable/build/windows-x86 --patch-dir ../appx-portable/patch
+```
+
+Choose an x64 build for an x64 game. Without `--patch-dir`, known-game patches are downloaded at the selected runtime release tag, including with `--build`.
+
+Upgrade the installer with `python -m pip install --upgrade pyappxportable`. Run it again with the original package and the same `--dest` to update a game. The Python package version and the runtime release version are independent.
+
+The CLI checks PyPI in the background at most once a day and prints an upgrade command when a newer compatible stable release is available. Checks never install updates or delay startup; offline failures stay silent. Use `--no-update-check` or set `PYAPPXPORTABLE_NO_UPDATE_CHECK=1` to disable them. `--help`, `--version`, and Python API calls do not check for updates. Use `pyappxportable --version` to show the installed package version.
+
+On macOS, the installer can set up Wine Devel, Rosetta 2, and GStreamer. Rosetta and GStreamer require administrator authorization; `--yes` prints instructions for those steps. See the [installer guide](https://github.com/yell0wsuit/appx-portable/blob/main/docs/installer.md) and [game compatibility](https://github.com/yell0wsuit/appx-portable/blob/main/docs/compatibility.md).
+
+## Python API
+
+```python
+from pyappxportable import InstallError, InstallOptions, install_game
+
+try:
+    install_game(InstallOptions(
+        package="Game.appx",
+        dest="Games/Game",
+        store="none",
+    ))
+except InstallError as error:
+    print(error)
+```
+
+The API runs without prompts by default and returns `0` on success. It raises `InstallError` for actionable installation problems; filesystem errors can also raise `OSError`. Set `yes=False` to enable prompts, optionally supplying an `ask` callback to `install_game`. `Manifest` is also exported for package metadata.
+
+## Development
+
+This project uses Hatchling and a `src/pyappxportable` package with a console entry point. Modules separate manifests/extraction, PE inspection, downloads, framework dependencies, runtime staging, patches, settings, desktop copies, launchers, macOS setup, and installation orchestration.
+
+```sh
+python -m venv .venv
+# Windows: .venv\Scripts\activate
+# macOS/Linux: source .venv/bin/activate
+python -m pip install -e ".[dev]"
+python -m pylint src/pyappxportable
+python -m black --check src/pyappxportable
+python -m build
+python -m twine check dist/*
+```
+
+CI lints, runs the update/release tests, builds wheel/source distributions, checks their metadata, and installs the wheel on Windows and Linux with Python 3.8, and on Windows, macOS, and Linux with the current Python.
+
+Pushes to `main` automatically publish to PyPI and create a GitHub release when any pushed commit starts with `feat:`, `fix:`, `perf:`, or `refactor:` (including scopes such as `fix(cli):`). Any conventional commit with `!` or a `BREAKING CHANGE:` footer also releases. Documentation, test, and chore commits only validate unless they declare a breaking change. A manual workflow run on `main` always releases. Publication requires the existing PyPI Trusted Publisher for workflow `build.yaml` and GitHub environment `pypi`.
+
+Versions use the UTC date, such as `2026.11.1`, with a fourth segment for repeat releases that day (`2026.11.1.1`, `2026.11.1.2`). Existing GitHub tags, releases, and PyPI versions are checked to avoid reuse. The workflow chooses and builds the version, publishes the validated distributions, and creates the matching `v` tag and GitHub release; no manual version bump or tag push is needed. Hatch VCS derives local checkout versions from Git tags, and the published source distribution retains its release version.
+
+## License
+
+[MIT](LICENSE). Extracted from `installappx.py` in Appx Portable by yell0wsuit. Games and Microsoft runtime files retain their own licenses.

pyappxportable-2026.11.1/README.md

@@ -0,0 +1,98 @@
+# pyappxportable
+
+Install Windows Store games as ordinary portable desktop games using [Appx Portable](https://github.com/yell0wsuit/appx-portable).
+
+Give the installer an `.appxbundle`, `.appx`, or extracted package folder. It extracts the game, downloads the matching Appx Portable runtime and required Microsoft framework packages, applies supported game patches, and writes a `00_click2startme` launcher. Updates preserve saves, settings, and logs.
+
+This package contains no games or Microsoft runtime files. Supply your own game packages. Runtime DLLs and game patches come from `yell0wsuit/appx-portable`; framework packages come from `yell0wsuit/vclibs-appx` with pinned SHA-256 checks.
+
+## Install
+
+Requires **Python 3.8 or later**, with pip. Use a Python release compatible with your Windows version; managed XAML games need Windows 10 1903 or later and .NET Framework 4.x. macOS/Wine support is experimental; managed games and games that require the native host need Windows.
+
+```sh
+python -m pip install pyappxportable
+pyappxportable "C:\Downloads\Game.appxbundle"
+```
+
+On Windows, `py -m pip` and `py -m pyappxportable` also work. On macOS/Linux, use `python3` if that is your Python command. With a Python installation managed by your OS, install into a virtual environment or use `pipx install pyappxportable`.
+
+Run `pyappxportable` without arguments for prompts. If the command is not on your PATH, use `python -m pyappxportable`. After installation, double-click `00_click2startme.bat` on Windows or `00_click2startme.command` on macOS. Linux uses `00_click2startme.sh` with Wine.
+
+## Command-line options
+
+```sh
+pyappxportable Game.appx --dest Games/Game --store none --launcher --yes
+python -m pyappxportable --help
+```
+
+| Option                           | Purpose                                                         |
+| -------------------------------- | --------------------------------------------------------------- |
+| `--version` | Show the installed pyappxportable version |
+| `--no-update-check` | Skip the background PyPI update check |
+| `--dest FOLDER`                  | Destination; defaults beside the source, using its package name |
+| `--dependencies PATH`            | VCLibs or .NET Native package/folder; repeat for several        |
+| `--build FOLDER`                 | Use locally built runtime DLLs                                  |
+| `--release TAG`                  | Select a runtime release instead of the latest                  |
+| `--store none\|trial\|iap\|both` | Store overrides; omitted with `--yes` preserves settings        |
+| `--launcher`, `--no-launcher`    | Create or skip the launcher; defaults to creating it            |
+| `--no-patch`                     | Skip known-game patches                                         |
+| `--patch-dir FOLDER`             | Use a local Appx Portable `patch/` folder                       |
+| `--desktop-copy`                 | Make a Windows 8/8.1 desktop executable copy on any Windows     |
+| `--yes`                          | Disable prompts; fail if a required input is missing            |
+
+For a local runtime checkout:
+
+```sh
+pyappxportable Game.appx --build ../appx-portable/build/windows-x86 --patch-dir ../appx-portable/patch
+```
+
+Choose an x64 build for an x64 game. Without `--patch-dir`, known-game patches are downloaded at the selected runtime release tag, including with `--build`.
+
+Upgrade the installer with `python -m pip install --upgrade pyappxportable`. Run it again with the original package and the same `--dest` to update a game. The Python package version and the runtime release version are independent.
+
+The CLI checks PyPI in the background at most once a day and prints an upgrade command when a newer compatible stable release is available. Checks never install updates or delay startup; offline failures stay silent. Use `--no-update-check` or set `PYAPPXPORTABLE_NO_UPDATE_CHECK=1` to disable them. `--help`, `--version`, and Python API calls do not check for updates. Use `pyappxportable --version` to show the installed package version.
+
+On macOS, the installer can set up Wine Devel, Rosetta 2, and GStreamer. Rosetta and GStreamer require administrator authorization; `--yes` prints instructions for those steps. See the [installer guide](https://github.com/yell0wsuit/appx-portable/blob/main/docs/installer.md) and [game compatibility](https://github.com/yell0wsuit/appx-portable/blob/main/docs/compatibility.md).
+
+## Python API
+
+```python
+from pyappxportable import InstallError, InstallOptions, install_game
+
+try:
+    install_game(InstallOptions(
+        package="Game.appx",
+        dest="Games/Game",
+        store="none",
+    ))
+except InstallError as error:
+    print(error)
+```
+
+The API runs without prompts by default and returns `0` on success. It raises `InstallError` for actionable installation problems; filesystem errors can also raise `OSError`. Set `yes=False` to enable prompts, optionally supplying an `ask` callback to `install_game`. `Manifest` is also exported for package metadata.
+
+## Development
+
+This project uses Hatchling and a `src/pyappxportable` package with a console entry point. Modules separate manifests/extraction, PE inspection, downloads, framework dependencies, runtime staging, patches, settings, desktop copies, launchers, macOS setup, and installation orchestration.
+
+```sh
+python -m venv .venv
+# Windows: .venv\Scripts\activate
+# macOS/Linux: source .venv/bin/activate
+python -m pip install -e ".[dev]"
+python -m pylint src/pyappxportable
+python -m black --check src/pyappxportable
+python -m build
+python -m twine check dist/*
+```
+
+CI lints, runs the update/release tests, builds wheel/source distributions, checks their metadata, and installs the wheel on Windows and Linux with Python 3.8, and on Windows, macOS, and Linux with the current Python.
+
+Pushes to `main` automatically publish to PyPI and create a GitHub release when any pushed commit starts with `feat:`, `fix:`, `perf:`, or `refactor:` (including scopes such as `fix(cli):`). Any conventional commit with `!` or a `BREAKING CHANGE:` footer also releases. Documentation, test, and chore commits only validate unless they declare a breaking change. A manual workflow run on `main` always releases. Publication requires the existing PyPI Trusted Publisher for workflow `build.yaml` and GitHub environment `pypi`.
+
+Versions use the UTC date, such as `2026.11.1`, with a fourth segment for repeat releases that day (`2026.11.1.1`, `2026.11.1.2`). Existing GitHub tags, releases, and PyPI versions are checked to avoid reuse. The workflow chooses and builds the version, publishes the validated distributions, and creates the matching `v` tag and GitHub release; no manual version bump or tag push is needed. Hatch VCS derives local checkout versions from Git tags, and the published source distribution retains its release version.
+
+## License
+
+[MIT](LICENSE). Extracted from `installappx.py` in Appx Portable by yell0wsuit. Games and Microsoft runtime files retain their own licenses.

pyappxportable-2026.11.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling >= 1.26", "hatch-vcs >= 0.4"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyappxportable"
+dynamic = ["version"]
+authors = [{ name = "yell0wsuit" }]
+description = "Install Windows Store game packages as portable Appx Portable games."
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+license-files = ["LICENSE*"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = ["packaging >= 20"]
+
+[project.optional-dependencies]
+dev = ["build", "pylint", "twine", "black"]
+
+[project.urls]
+Homepage = "https://github.com/yell0wsuit/pyappxportable"
+Issues = "https://github.com/yell0wsuit/pyappxportable/issues"
+Runtime = "https://github.com/yell0wsuit/appx-portable"
+
+[project.scripts]
+pyappxportable = "pyappxportable.main:main"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+fallback_version = "0.1.0"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyappxportable"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/src", "/README.md", "/LICENSE*", "/pyproject.toml"]
+
+[tool.pylint.main]
+py-version = "3.8"
+
+[tool.pylint.format]
+max-line-length = 100
+
+[tool.black]
+target-version = ["py38"]

pyappxportable-2026.11.1/src/pyappxportable/__init__.py

@@ -0,0 +1,8 @@
+"""Install Windows Store games as portable desktop applications."""
+
+from pyappxportable.errors import InstallError
+from pyappxportable.installer import install_game
+from pyappxportable.manifest import Manifest
+from pyappxportable.options import InstallOptions
+
+__all__ = ["InstallError", "InstallOptions", "Manifest", "install_game"]

pyappxportable-2026.11.1/src/pyappxportable/__main__.py

@@ -0,0 +1,5 @@
+"""Run the installer with python -m pyappxportable."""
+
+from pyappxportable.main import main
+
+raise SystemExit(main())

pyappxportable-2026.11.1/src/pyappxportable/constants.py

@@ -0,0 +1,22 @@
+"""Constants helpers for portable Windows Store games."""
+
+import re
+
+ARCHITECTURES = {0x14C: "x86", 0x8664: "x64"}
+# Package files the game never reads.
+PACKAGE_METADATA = {
+    "appxsignature.p7x",
+    "appxblockmap.xml",
+    "[content_types].xml",
+    "appxmetadata",
+    "microsoft.system.package.metadata",
+}
+# Bundle application packages in order of preference: Windows 8 and 8.1 games
+# are tested as x86, Windows 10 games as x64.
+BUNDLE_ARCHITECTURES = ("x86", "neutral", "x64")
+UNIVERSAL_BUNDLE_ARCHITECTURES = ("x64", "neutral", "x86")
+IDENTITY_NAME = re.compile(r"^(?=.*[A-Za-z0-9])[A-Za-z0-9.-]{3,50}$")
+INVALID_NAME = re.compile(r'[<>:"|?*\x00-\x1f]')
+
+PROXIES = ("d3dcompiler_47.dll", "XAudio2_8.dll", "DWrite.dll")
+REPOSITORY = "yell0wsuit/appx-portable"