Deprecated bdist_wheel and updated the README (#631) · pypa/wheel@0add7d6 (original) (raw)

1

1

`wheel

`

2

2

`=====

`

3

3

``

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:

``

6

6

``

7

``

`-

It has two different roles:

`

``

7


* Convert ``.egg`` archives into ``.whl``

``

8

`+

`

``

9

`+

`

``

10

`+

`

8

11

``

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

`+

`

12

16

``

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!

`

15

21

``

16

``

`-

.. _PEP 427: https://www.python.org/dev/peps/pep-0427/

`

17

22

`.. _setuptools: https://pypi.org/project/setuptools/

`

18

23

``

19

24

`Documentation

`