Skip to main content

Cross-platform Python library for creating, extracting and signing MSIX packages

Project description

pymsix

Cross-platform Python library for creating, extracting and signing MSIX packages. Wraps makeappx.exe (Windows) or makemsix (Linux) — binaries are resolved automatically.

Requirements

  • Python 3.10+
Platform Requirements
Windows Windows 10 SDK
Linux osslsigncode (for signing)

On Linux, makemsix is bundled with the package and requires no additional setup.

Installation

pip install pymsix

Usage

from msix import MsixPacker

packer = MsixPacker()
packer.pack("path/to/app-content/", "output/MyApp.msix")
packer.unpack("output/MyApp.msix", "path/to/extracted/")

The app-content/ directory must contain a valid AppxManifest.xml.

Signing

packer.sign("output/MyApp.msix", "cert.pfx", pfx_password="s3cr3t")

API

MsixPacker(binary=None, sign_binary=None, verbose=False)

Parameter Description
binary Path to makeappx.exe (Windows) or makemsix (Linux). Auto-resolved if omitted.
sign_binary Path to signtool.exe (Windows) or osslsigncode (Linux). Auto-resolved if omitted.
verbose Print the command being executed.

pack(content_dir, output_package, *, overwrite=True, skip_validation=False, hash_algorithm="SHA256")

Creates an MSIX package from a directory. Returns the path to the created file.

Note: overwrite, skip_validation, and hash_algorithm are only supported on Windows (makeappx.exe). These parameters are silently ignored on Linux, as makemsix does not support them.

unpack(package, output_dir, *, overwrite=True)

Extracts an MSIX package into a directory. Returns the path to the extraction directory.

Note: overwrite is only supported on Windows (makeappx.exe). This parameter is silently ignored on Linux, as makemsix does not support it.

sign(package, pfx, *, pfx_password=None, timestamp_url="http://timestamp.digicert.com", digest_algorithm="SHA256")

Signs an MSIX package in-place using a PFX certificate. Returns the path to the signed file.

On Windows, signtool.exe is used (auto-detected from the Windows SDK). On Linux, osslsigncode must be installed:

# Debian/Ubuntu
sudo apt install osslsigncode

# Fedora/RHEL
sudo dnf install osslsigncode
Parameter Description
package Path to the .msix file to sign.
pfx Path to the .pfx certificate file.
pfx_password Password for the .pfx file. Omit if not password-protected.
timestamp_url RFC 3161 timestamp server URL. Set to "" to disable timestamping.
digest_algorithm Digest algorithm for the signature (default "SHA256").

Binary Resolution Order

Pack binary (makeappx.exe / makemsix)

  1. binary constructor argument
  2. PYMSIX_BINARY environment variable
  3. Windows SDK makeappx.exe (Windows only)
  4. Bundled makemsix binary (Linux only)

Sign binary (signtool.exe / osslsigncode)

  1. sign_binary constructor argument
  2. PYMSIX_SIGN_BINARY environment variable
  3. Windows SDK signtool.exe (Windows only)
  4. osslsigncode on PATH (Linux only)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymsix-1.1.0.tar.gz (47.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymsix-1.1.0-py3-none-any.whl (46.1 kB view details)

Uploaded Python 3

File details

Details for the file pymsix-1.1.0.tar.gz.

File metadata

  • Download URL: pymsix-1.1.0.tar.gz
  • Upload date:
  • Size: 47.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.4

File hashes

Hashes for pymsix-1.1.0.tar.gz
Algorithm Hash digest
SHA256 5bd7fafd13e968d4ae5f6f5ce9f8f11d996c994b2a2708b6ea2da66f8e6eb00b
MD5 623fdb32bc32c9c9eb027cf7b7c4c78c
BLAKE2b-256 47be2094d422794acbc7c2388f3452c28d9624375c78e48bc7d986f19b6dab52

See more details on using hashes here.

File details

Details for the file pymsix-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pymsix-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 46.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.4

File hashes

Hashes for pymsix-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0be9a8ed8e2fb79041dd2ff532d4ad898ee90f2c9debbeb27b2c3ad6b192ff14
MD5 5b480112da6607dd8c20ca2e2a4ab443
BLAKE2b-256 5ec639213b2a6b6936dd13603dd35b3ab87db2184bc689e5b604ec05e112f960

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page