ziglang/zig-pypi

Zig PyPI distribution

This repository contains the script used to repackage the releases of the Zig programming language as Python binary wheels. This document is intended for maintainers; see the package README for rationale and usage instructions.

The repackaged artifacts are published as the ziglang PyPI package.

Preparation

The script requires Python 3.9 and later and a PEP 723 compatible script runner, such as pipx, pdm, hatch, uv, or similar. Please refer to their documentation for installation instructions.

Building wheels

Run the repackaging script. Here's an example invocation with pdm:

$ pdm run make_wheels.py --help
usage: make_wheels.py [-h] [--version VERSION] [--suffix SUFFIX] [--outdir OUTDIR]
                                                  [--platform {x86_64-windows,x86_64-macos,aarch64-macos,i386-linux,x86-linux,x86_64-linux,aarch64-linux,armv7a-linux}]

Repackage official Zig downloads as Python wheels

options:
  -h, --help            show this help message and exit
  --version VERSION     version to package, use `latest` for latest release, `master` for nightly build
  --suffix SUFFIX       wheel version suffix
  --outdir OUTDIR       target directory
  --platform {x86_64-windows,x86_64-macos,aarch64-macos,i386-linux,x86-linux,x86_64-linux,aarch64-linux,armv7a-linux}
                        platform to build for, can be repeated

This command will download the Zig release archives for every supported platform and convert them to binary wheels, which are placed under dist/. The Zig version and platforms can be passed as arguments.

The process of converting release archives to binary wheels is deterministic, and the output of the script should be bit-for-bit identical regardless of the environment and platform it runs under. To this end, it prints the SHA256 hashes of inputs and outputs; the hashes of the inputs will match the ones on the Zig downloads page, and the hashes of the outputs will match the ones on the PyPI downloads page.

Uploading wheels to PyPI

Trigger the publishing workflow from this repository manually (requires authorization) with the necessary inputs as mentioned in the workflow file or in the GitHub Actions UI. The wheels are checked with twine before they are uploaded.

The workflow will upload the wheels to PyPI to make them available for installation. It is possible to trigger it multiple times to upload wheels for different versions or platforms.

Verifying the provenance of wheels uploaded to PyPI

To establish build provenance, the workflow generates attestations for the uploaded wheels using the GitHub Actions Attestations feature when it is run. Please navigate to the Attestations interface to view the attestations for the uploaded wheels.

The attestations may be verified via the GitHub (gh) CLI or via the GitHub API.

License

This script is distributed under the terms of the MIT (Expat) license.

Please refer to the Zig license for the terms of use of the Zig programming language itself, or look in the .dist-info/licenses/ directory of the built wheels for individual licenses of the bundled components.