summaryrefslogtreecommitdiff
path: root/docs/reference/wheel_unpack.rst
blob: 420f6103d946a5f05cce30c4df7cf21307303af5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
wheel unpack
============

Usage
-----

::

    wheel unpack <wheel_file>


Description
-----------

Unpack the given wheel file.

This is the equivalent of ``unzip <wheel_file>``, except that it also checks
that the hashes and file sizes match with those in ``RECORD`` and exits with an
error if it encounters a mismatch.


Options
-------

.. option:: -d, --dest-dir <dir>

    Directory to unpack the wheel into.


Examples
--------

* Unpack a wheel::

    $ wheel unpack someproject-1.5.0-py2-py3-none.whl
    Unpacking to: ./someproject-1.5.0

* If a file's hash does not match::

    $ wheel unpack someproject-1.5.0-py2-py3-none.whl
    Unpacking to: ./someproject-1.5.0
    Traceback (most recent call last):
    ...
    wheel.install.BadWheelFile: Bad hash for file 'mypackage/module.py'
    $ echo $?
    1