Skip to content

Commit

Permalink
Deprecated bdist_wheel and updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
agronholm committed Aug 4, 2024
1 parent 1e00742 commit 20ac033
Show file tree
Hide file tree
Showing 7 changed files with 635 additions and 617 deletions.
23 changes: 14 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
wheel
=====

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

It has two different roles:
* Convert ``.egg`` archives into ``.whl``
* Unpack wheel archives
* Repack wheel archives
* Add or remove tags in existing wheel archives

#. A setuptools_ extension for building wheels that provides the
``bdist_wheel`` setuptools command
#. A command line tool for working with wheel files
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/

Historical note
---------------

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

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

Documentation
Expand Down
4 changes: 3 additions & 1 deletion docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Release Notes

**UNRELEASED**

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

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

Expand Down
Loading

0 comments on commit 20ac033

Please sign in to comment.