wheel-matrix

wheel-matrix is a Python tool that simplifies the complexity of managing Python package distributions by generating a comprehensive Markdown matrix of available wheel files for different Python versions and platforms. This tool aids in the visualization of compatibility and availability of wheel files for Python packages across various operating systems (Linux, Windows, macOS) and architectures (x86_64, i686, arm64, etc.), streamlining the process of identifying the necessary distributions for package users and maintainers.

Features

• Generates a Markdown formatted matrix of available wheel distributions.
• Supports multiple platforms including Linux, Windows, and macOS.
• Identifies distributions for a range of Python versions, considering only versions newer than Python 3.7.
• Easy to integrate into documentation or CI/CD pipelines for automated updates.

Example

This table was produced by wheel-matrix pyfxr:

Installation

wheel-matrix can be installed from PyPI with pip:

pip install wheel-matrix

Ensure you have Python 3.10 or newer to run wheel-matrix.

Usage

To use wheel-matrix, run the following command in your terminal:

wheel-matrix <package-name> [<version>] [--platforms=all] [--output=md|json|gha-matrix]

• <package-name>: Name of the Python package for which to generate the wheel matrix.
• <version>: (Optional) Specific version of the package. If not provided, the latest version will be used.
• --platforms=all: Include every architecture known to the tool, instead of the recommended subset.
• --output=: Select the output format. md (default) prints a Markdown table, json prints the raw data and gha-matrix prints a GitHub Actions matrix describing the missing wheels.

Example:

wheel-matrix pandas

This will print a Markdown formatted matrix to the console, showing the availability of wheel files for different combinations of Python versions and operating systems.

Contributing

Contributions to wheel-matrix are welcome!

Please feel free to submit pull requests or create issues on the GitHub repository.

License

wheel-matrix is released under the MIT License. See the LICENSE file in the GitHub repository for more details.