Skip to content

Commit c1fbf45

Browse files
committed
docs: adding docs for wheel tags
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 239d213 commit c1fbf45

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

docs/reference/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ Reference Guide
77
wheel_convert
88
wheel_unpack
99
wheel_pack
10+
wheel_tags

docs/reference/wheel_tags.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
wheel tags
2+
==========
3+
4+
Usage
5+
-----
6+
7+
::
8+
9+
wheel tagstags [-h] [--remove] [--python-tag TAG] [--abi-tag TAG] [--platform-tag TAG] [--build NUMBER] WHEEL [...]
10+
11+
Description
12+
-----------
13+
14+
Make a new wheel with given tags from and existing wheel. Any tags left
15+
unspecified will remain the same. Multiple tags are separated by a "." Starting
16+
with a "+" will append to the existing tags. Starting with a "-" will remove a
17+
tag. The original file will remain unless ``--remove`` is given. The output
18+
filename(s) will be displayed on stdout for further processing.
19+
20+
21+
Options
22+
-------
23+
24+
.. option:: --remove
25+
26+
Remove the original wheel, keeping only the retagged wheel.
27+
28+
.. option:: --python-tag TAG
29+
30+
Override the python tag (prepend with "+" to append, "-" to remove).
31+
Multiple tags can be separated with a dot.
32+
33+
.. option:: --abi-tag TAG
34+
35+
Override the abi tag (prepend with "+" to append, "-" to remove).
36+
Multiple tags can be separated with a dot.
37+
38+
.. option:: --platform-tag TAG
39+
40+
Override the platform tag (prepend with "+" to append, "-" to remove).
41+
Multiple tags can be separated with a dot.
42+
43+
.. option:: --build NUMBER
44+
45+
Specify a build number.
46+
47+
Examples
48+
--------
49+
50+
* Replace a wheel's Python specific tags with generic tags (if no Python extensions are present, for example)::
51+
52+
$ wheel tags --python-tag py2.py3 --abi-tag none cmake-3.20.2-cp39-cp39-win_amd64.whl
53+
cmake-3.20.2-py2.py3-none-win_amd64.whl
54+
55+
* Add compatibility tags for macOS universal wheels and older pips::
56+
57+
$ wheel tags \
58+
--platform-tag +macosx_10_9_x86_64.macosx_11_0_arm64 \
59+
ninja-1.11.1-py2.py3-none-macosx_10_9_universal2.whl
60+
ninja-1.11.1-py2.py3-none-macosx_10_9_universal2.macosx_10_9_x86_64.macosx_11_0_arm64.whl

0 commit comments

Comments
 (0)