Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecated bdist_wheel and updated the README #631

Merged
merged 4 commits into from
Aug 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading