Wheel

https://wheel.readthedocs.io/en/stable/
Admin
Wheel is a command-line tool and library for working with Python wheel packages, providing...
Tokens:11,799
Snippets:218
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install a Wheel

Source: https://wheel.readthedocs.io/en/stable/_sources/user_guide.rst.txt

Use pip to install a wheel file. This is the standard method for installing wheel packages.

```bash
pip install someproject-1.5.0-py2-py3-none.whl
```

--------------------------------

### Build a Wheel

Source: https://wheel.readthedocs.io/en/stable/user_guide.html

Use pip to install the build package and then run the build command to create a wheel file.

```bash
python -m pip install build
python -m build --wheel

```

--------------------------------

### Install wheel using pip

Source: https://wheel.readthedocs.io/en/stable/installing.html

Use this command to install the wheel package. Ensure pip is installed first.

```bash
pip install wheel

```

--------------------------------

### Build a Wheel

Source: https://wheel.readthedocs.io/en/stable/_sources/quickstart.rst.txt

Use the 'build' package to create a wheel distribution for your project. Ensure you have the 'build' package installed.

```bash
python -m pip install build
python -m build --wheel
```

--------------------------------

### Install Test Dependencies and Run Pytest

Source: https://wheel.readthedocs.io/en/stable/development.html

Install the project in editable mode with test dependencies and run tests using pytest with the current interpreter. Recommended to use a virtual environment.

```bash
$ pip install -e .[test]  # Installs the test dependencies
$ pytest                  # Runs the tests with the current interpreter

```

--------------------------------

### Convert Windows Installer to Wheel

Source: https://wheel.readthedocs.io/en/stable/_sources/quickstart.rst.txt

Use the 'wheel convert' command to transform a Windows installer (.exe) into a wheel format.

```bash
wheel convert yourinstaller.exe
```

--------------------------------

### Repack Wheel with New Build Number

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_pack.rst.txt

Example demonstrating unpacking a wheel, modifying its contents by adding a file, and then repacking it with a new build number.

```bash
$ wheel unpack someproject-1.5.0-py2-py3-none.whl
Unpacking to: ./someproject-1.5.0
$ touch someproject-1.5.0/somepackage/module.py
$ wheel pack --build-number 2 someproject-1.5.0
Repacking wheel as ./someproject-1.5.0-2-py2-py3-none.whl...OK
```

--------------------------------

### Install Wheel using pip

Source: https://wheel.readthedocs.io/en/stable/_sources/installing.rst.txt

Use this command to install the wheel package with pip. Ensure pip is installed first.

```bash
pip install wheel
```

--------------------------------

### Install Test Dependencies and Run Pytest

Source: https://wheel.readthedocs.io/en/stable/_sources/development.rst.txt

Install the project in editable mode with test dependencies and run the test suite using pytest.

```bash
pip install -e .[test]
pytest
```

--------------------------------

### Display Detailed Wheel Information with File Listing

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_info.rst.txt

Employ the --verbose option to get an exhaustive listing of all files within the wheel, including their individual sizes. This provides a granular view of the package's structure and content.

```bash
$ wheel info --verbose example_package-1.0-py3-none-any.whl
Name: example-package
Version: 1.0
...

File listing:
  example_package/__init__.py                                      45 bytes
  example_package/module.py                                     1,234 bytes
  example_package-1.0.dist-info/METADATA                         678 bytes
  example_package-1.0.dist-info/WHEEL                            123 bytes
  example_package-1.0.dist-info/RECORD                           456 bytes
```

--------------------------------

### Clone and Commit Changes

Source: https://wheel.readthedocs.io/en/stable/development.html

Basic Git commands for cloning the repository, making changes, and committing them. Assumes a GitHub fork setup.

```bash
$ git clone git@github.com:pypa/wheel.git
$ cd wheel
# ...
$ git diff
$ git add <modified> ...
$ git status
$ git commit

```

--------------------------------

### Handle wheel file hash mismatch

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_unpack.rst.txt

This example demonstrates the output when a wheel file's hash does not match the one recorded in the RECORD file. The command exits with an error code of 1 in such cases.

```bash
$ wheel unpack someproject-1.5.0-py2-py3-none.whl
Unpacking to: ./someproject-1.5.0
Traceback (
most recent call last):
...
wheel.install.BadWheelFile: Bad hash for file 'mypackage/module.py'
$ echo $?
1
```

--------------------------------

### Inspect Wheel Metadata

Source: https://wheel.readthedocs.io/en/stable/_sources/user_guide.rst.txt

Use 'wheel info' to inspect the metadata and contents of a wheel file without installing it. The --verbose flag provides more detailed information.

```bash
wheel info someproject-1.5.0-py2-py3-none.whl
```

```bash
wheel info --verbose someproject-1.5.0-py2-py3-none.whl
```

--------------------------------

### Handle invalid egg file names

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_convert.rst.txt

This example demonstrates the error message and exit code when attempting to convert an egg file with an invalid name. Ensure egg names follow the format: name-version-pyX.Y.egg.

```bash
$ wheel convert pycharm-debug.egg
"pycharm-debug.egg" is not a valid egg name (must match at least name-version-pyX.Y.egg)
$ echo $?
```

--------------------------------

### Specify License Files

Source: https://wheel.readthedocs.io/en/stable/_sources/user_guide.rst.txt

Configure license files to be included in the wheel's .dist-info directory by setting 'license_files' in setup.cfg. An empty value disables this functionality.

```cfg
[metadata]
license_files =
   license.txt
   3rdparty/*.txt
```

--------------------------------

### Specify License Files

Source: https://wheel.readthedocs.io/en/stable/user_guide.html

Customize which license files are included in the wheel by setting the license_files option in setup.cfg. Files are placed in the .dist-info directory.

```ini
[metadata]
license_files =
   license.txt
   3rdparty/*.txt

```

--------------------------------

### Configure Universal Wheels

Source: https://wheel.readthedocs.io/en/stable/_sources/quickstart.rst.txt

Add this section to your setup.cfg file to build universal (Python 2/3 compatible, pure Python) wheels.

```ini
[bdist_wheel]
universal = 1
```

--------------------------------

### Display Basic Wheel Information

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_info.rst.txt

Use this command to view essential metadata of a wheel file, such as package name, version, and tags. This is useful for quickly identifying the contents of a wheel.

```bash
$ wheel info example_package-1.0-py3-none-any.whl
Name: example-package
Version: 1.0
Wheel-Version: 1.0
Root-Is-Purelib: true
Tags:
  py3-none-any
Generator: bdist_wheel (0.40.0)
Summary: An example package
Author: John Doe
License: MIT
Files: 12
Size: 15,234 bytes
```

--------------------------------

### Wheel Unpack Usage

Source: https://wheel.readthedocs.io/en/stable/reference/wheel_unpack.html

This shows the basic command-line syntax for unpacking a wheel file. It requires the path to the wheel file as an argument.

```bash
wheel unpack <wheel_file>
```

--------------------------------

### Wheel Pack Command Usage

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_pack.rst.txt

Basic usage of the wheel pack command, specifying the directory to repack.

```bash
wheel pack <wheel_directory>
```

--------------------------------

### Clone and Commit Changes for Pull Request

Source: https://wheel.readthedocs.io/en/stable/_sources/development.rst.txt

Steps to clone the repository, make changes, and prepare for a commit when contributing to the Wheel project.

```bash
git clone git@github.com:pypa/wheel.git
cd wheel
# ...
git diff
git add <modified> ...
git status
git commit
```

--------------------------------

### Run All Tests with Tox

Source: https://wheel.readthedocs.io/en/stable/_sources/development.rst.txt

Execute the test suite against all supported Python interpreters using tox.

```bash
tox
```

--------------------------------

### Specify Output Directory for Conversion

Source: https://wheel.readthedocs.io/en/stable/user_guide.html

Use the --dest-dir option with the wheel convert command to specify a different directory for the resulting wheels.

```bash
wheel convert --dest-dir /tmp blah-1.2.3-py2.7.egg

```

--------------------------------

### Run All Tests Locally with Tox

Source: https://wheel.readthedocs.io/en/stable/development.html

Execute the test suite against all matching Python interpreters using tox.

```bash
$ tox

```

--------------------------------

### Convert Egg to Wheel

Source: https://wheel.readthedocs.io/en/stable/_sources/quickstart.rst.txt

Use the 'wheel convert' command to transform an .egg file or directory into a wheel format.

```bash
wheel convert youreggfile.egg
```

--------------------------------

### Wheel Tags Command Usage

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_tags.rst.txt

Displays the command-line usage for the 'wheel tags' command, including available options and arguments.

```bash
wheel tags [-h] [--remove] [--python-tag TAG] [--abi-tag TAG] [--platform-tag TAG] [--build NUMBER] WHEEL [...]
```

--------------------------------

### Convert Eggs to Wheels

Source: https://wheel.readthedocs.io/en/stable/_sources/user_guide.rst.txt

Convert .egg files or directories to the wheel format. Multiple eggs can be converted at once, and wildcard expansion is supported.

```bash
wheel convert blah-1.2.3-py2.7.egg foo-2.0b1-py3.5.egg
```

```bash
wheel convert *.egg
```

```bash
wheel convert --dest-dir /tmp blah-1.2.3-py2.7.egg
```

--------------------------------

### Convert a single egg file

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_convert.rst.txt

Use this command to convert a single egg file into a wheel. The generated wheel will be stored in the current directory by default.

```bash
$ wheel convert foobar-1.2.3-py2.7.egg
$ ls *.whl
foobar-1.2.3-py27-none.whl
```

--------------------------------

### Unpack a wheel file

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_unpack.rst.txt

Use this command to unpack a wheel file. It is similar to unzip but includes integrity checks against the RECORD file.

```bash
$ wheel unpack someproject-1.5.0-py2-py3-none.whl
Unpacking to: ./someproject-1.5.0
```

--------------------------------

### Run Tests with Specific Tox Environment

Source: https://wheel.readthedocs.io/en/stable/_sources/development.rst.txt

Execute the test suite using tox for a specific Python environment, such as py39.

```bash
tox -e py39
```

--------------------------------

### Run Tox Tests for Specific Environment

Source: https://wheel.readthedocs.io/en/stable/development.html

Execute the test suite using tox for a specific Python environment, such as py39.

```bash
$ tox -e py39

```

--------------------------------

### Add Compatibility Tags for macOS

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_tags.rst.txt

Adds compatibility tags for macOS universal wheels and older pip versions. This ensures broader compatibility across different macOS versions and architectures.

```bash
$ wheel tags \
    --platform-tag=+macosx_10_9_x86_64.macosx_11_0_arm64 \
    ninja-1.11.1-py2.py3-none-macosx_10_9_universal2.whl
ninja-1.11.1-py2.py3-none-macosx_10_9_universal2.macosx_10_9_x86_64.macosx_11_0_arm64.whl
```

--------------------------------

### Push Changes to Fork

Source: https://wheel.readthedocs.io/en/stable/_sources/development.rst.txt

Command to push local commits to your forked repository on GitHub.

```bash
git push git@github.com:yourname/wheel.git
```

--------------------------------

### Push Changes to GitHub Fork

Source: https://wheel.readthedocs.io/en/stable/development.html

Command to push local commits to your GitHub fork of the Wheel repository.

```bash
$ git push git@github.com:yourname/wheel.git

```

--------------------------------

### Replace Wheel Tags

Source: https://wheel.readthedocs.io/en/stable/_sources/reference/wheel_tags.rst.txt

Replaces a wheel's Python and ABI specific tags with generic tags. This is useful for wheels without Python extensions.

```bash
$ wheel tags --python-tag=py2.py3 --abi-tag=none cmake-3.20.2-cp39-cp39-win_amd64.whl
cmake-3.20.2-py2.py3-none-win_amd64.whl
```
Tokens:
Raw