auditwheel

Warnings

• breaking Python 3.7, 3.8, and 3.9 support has been successively dropped in recent major/minor versions. auditwheel 6.0.0 dropped Python 3.7, 6.2.0 dropped Python 3.8, and 6.5.0 dropped Python 3.9.
  Fix: Ensure your build environment uses Python 3.10 or newer. Check `requires_python` in the PyPI metadata for the exact minimum version.
• breaking The `addtag` subcommand was removed in version 6.0.0.
  Fix: The functionality of `addtag` is now integrated into `auditwheel repair` or handled automatically. Refer to the official documentation for updated wheel tagging procedures.
• gotcha auditwheel primarily processes dependencies specified via `DT_NEEDED` (like `ldd`). It cannot statically detect or repair shared libraries that are dynamically loaded at runtime using mechanisms like `ctypes`, `cffi`, or `dlopen` from C/C++ code.
  Fix: Manually ensure that dynamically loaded libraries are available in the target environment or bundled through other means if they are not system-provided.
• gotcha auditwheel is a Linux-specific tool and does not operate on wheels built for other operating systems. For macOS, the `delocate` tool is typically used, and for Windows, `delvewheel` or `repairwheel` are alternatives.
  Fix: Use platform-specific tools for wheel repair on macOS (`delocate`) and Windows (`delvewheel`, `repairwheel`).
• gotcha auditwheel requires the `patchelf` utility to be installed and available in the system's PATH. This is an external operating system dependency, not a Python package.
  Fix: Install `patchelf` via your system's package manager (e.g., `apt install patchelf`, `yum install patchelf`, `brew install patchelf`). Ensure it's version 0.14 or newer.

Install

• pip install auditwheel Install stable version

Imports

• auditwheel

  auditwheel <subcommand> [options] <wheelfile>

  auditwheel is primarily a command-line utility; direct Python imports of its core functionality are not common for end-users. Its primary interface is through shell commands like `auditwheel show` and `auditwheel repair`.

Quickstart

This example demonstrates the typical command-line usage of `auditwheel`. First, it creates a dummy wheel file (in a real scenario, this would be a wheel containing compiled C/C++ extensions). Then, it uses `auditwheel show` to inspect the wheel's dependencies and ABI compliance. Finally, `auditwheel repair` is used to bundle any non-compliant shared libraries into the wheel and update its platform tag to a `manylinux` tag, outputting the repaired wheel to a specified directory. This process is usually executed within a `manylinux` Docker container to ensure a consistent build environment compatible with older Linux distributions.

#!/bin/bash

# This quickstart demonstrates auditwheel's primary command-line usage.
# In a real scenario, you would typically build a wheel containing compiled extensions
# and then use auditwheel within a manylinux Docker environment.

# 1. Create a dummy wheel file for demonstration purposes.
#    Replace 'my_package-1.0-py310-none-any.whl' with your actual wheel.
#    For a real test, ensure this wheel has compiled native extensions.
mkdir -p dist
echo "Dummy content" > dist/my_package-1.0-py310-none-linux_x86_64.whl

echo "\n--- Inspecting the wheel with 'auditwheel show' ---"
auditwheel show dist/my_package-1.0-py310-none-linux_x86_64.whl

echo "\n--- Repairing the wheel with 'auditwheel repair' ---"
mkdir -p repaired_wheels
auditwheel repair dist/my_package-1.0-py310-none-linux_x86_64.whl -w repaired_wheels

echo "\n--- Listing repaired wheels ---"
ls repaired_wheels

# Clean up dummy files
rm -rf dist repaired_wheels