Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

WhatYouShip

Know what you ship. Know what you install.

WhatYouShip is an open-source release artifact linter. It analyzes the finished software package that users actually receive—not the source tree or build configuration. Use it to inspect release contents, apply release-quality rules, and compare two releases.

Supported top-level artifacts are directories, Windows MSI packages, ZIP archives, NSIS installers, Inno Setup installers, and macOS DMG images. WhatYouShip also analyzes PE and Mach-O binaries and macOS application bundles inside those artifacts when the required metadata and platform tools are available.

Installation

WhatYouShip requires Python 3.11 or newer.

python -m pip install whatyouship

Some formats require external extraction tools. See the installation and requirements guide for the platform matrix.

Quick examples

whatyouship inspect release.msi
whatyouship lint release.msi
whatyouship lint release.msi --baseline previous.msi
whatyouship compare previous.msi release.msi
whatyouship lint release.msi --baseline previous.msi -o lint.json

WhatYouShip can identify suspicious build artifacts, unsigned or invalidly signed binaries and packages where verification is supported, malformed macOS application bundles, incompatible bundled architectures, non-portable runtime search paths, inconsistent MSI installation scope, and missing supported license metadata. Comparison covers file changes and semantic changes such as versions, architectures, dependencies, signatures, bundles, links, and MSI scope.

The high-level Python API returns the same structured operation results:

from whatyouship.operations import inspect, lint, compare

inspection = inspect("release.msi")
lint_report = lint("release.msi", baseline="previous.msi")
comparison = compare("previous.msi", "release.msi")

The Python API is experimental until 1.0.

Documentation

WhatYouShip is a release linter, not an MSI validator, SBOM generator, or security scanner. Detailed platform limitations, report contracts, cache behavior, and contribution guidance live in the documentation.

License

MIT

Metadata

Release files for whatyouship 0.1.0b3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for whatyouship 0.1.0b3
File Size Uploaded Provenance Actions
whatyouship-0.1.0b3.tar.gz 82.8 kB Without provenance Details for whatyouship-0.1.0b3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for whatyouship 0.1.0b3
File Interpreter ABI Platform Actions
whatyouship-0.1.0b3-py3-none-any.whl Python 3 none any Details for whatyouship-0.1.0b3-py3-none-any.whl

Total release size: 196.0 kB

Release files / whatyouship-0.1.0b3.tar.gz

Download URL whatyouship-0.1.0b3.tar.gz
Size 82.8 kB
Tags Source
SHA-256 checksum
How to use checksums
c8e7f35862337b8ec468f97a91d5dc5f3868013824227d8e282eccd8c8b61d3e
BLAKE2b-256 checksum
How to use checksums
f2ce1086a385d9297ca4a3f6c030865fc0cd3e9041737e3f862c4bb13c453fbc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / whatyouship-0.1.0b3-py3-none-any.whl

Download URL whatyouship-0.1.0b3-py3-none-any.whl
Size 113.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
15f894045a8ba84791b68d7682052f4d85d8f3b8fe993d7ebdede0c5cb73ed49
BLAKE2b-256 checksum
How to use checksums
6efb97a39d75e279cc41befb09601f3bd6a7fa96c5a5dea99a54232c84df49ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Security for whatyouship 0.1.0b3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page