Skip to content

Commit 0add7d6

Browse files
authored
Deprecated bdist_wheel and updated the README (#631)
1 parent 46c2389 commit 0add7d6

File tree

7 files changed

+642
-617
lines changed

7 files changed

+642
-617
lines changed

README.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
wheel
22
=====
33

4-
This library is the reference implementation of the Python wheel packaging
5-
standard, as defined in `PEP 427`_.
4+
This is a command line tool for manipulating Python wheel files, as defined in
5+
`PEP 427`_. It contains the following functionality:
66

7-
It has two different roles:
7+
* Convert ``.egg`` archives into ``.whl``
8+
* Unpack wheel archives
9+
* Repack wheel archives
10+
* Add or remove tags in existing wheel archives
811

9-
#. A setuptools_ extension for building wheels that provides the
10-
``bdist_wheel`` setuptools command
11-
#. A command line tool for working with wheel files
12+
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
13+
14+
Historical note
15+
---------------
1216

13-
It should be noted that wheel is **not** intended to be used as a library, and
14-
as such there is no stable, public API.
17+
This project used to contain the implementation of the setuptools_ ``bdist_wheel``
18+
command, but as of setuptools v70.1, it no longer needs ``wheel`` installed for that to
19+
work. Thus, you should install this **only** if you intend to use the ``wheel`` command
20+
line tool!
1521

16-
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
1722
.. _setuptools: https://pypi.org/project/setuptools/
1823

1924
Documentation

docs/news.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Release Notes
33

44
**UNRELEASED**
55

6-
- Canonicalize requirements in METADATA file (PR by Wim Jeantine-Glenn)
6+
- Canonicalized requirements in METADATA file (PR by Wim Jeantine-Glenn)
7+
- Deprecated the ``bdist_wheel`` module, as the code was migrated to ``setuptools``
8+
itself
79

810
**0.43.0 (2024-03-11)**
911

0 commit comments

Comments
 (0)