diff options
| author | Alex Grönholm <alex.gronholm@nextday.fi> | 2018-07-15 17:42:25 +0300 |
|---|---|---|
| committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2018-07-17 15:02:50 +0300 |
| commit | 3328624c70b6328f10050507a63da0438d3882be (patch) | |
| tree | 324a309058a0570944c971eeef5e9519c721d0ac /docs | |
| parent | e90cabb29e8e7ed89c6fa4ebfca5183433e134b6 (diff) | |
| download | wheel-git-3328624c70b6328f10050507a63da0438d3882be.tar.gz | |
Added the "wheel pack" command
Fixes #157. Fixes #168.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/news.rst | 1 | ||||
| -rw-r--r-- | docs/reference/index.rst | 1 | ||||
| -rw-r--r-- | docs/reference/wheel_pack.rst | 39 |
3 files changed, 41 insertions, 0 deletions
diff --git a/docs/news.rst b/docs/news.rst index 27a5624..8fa66cd 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,6 +5,7 @@ Release Notes - Removed wheel signing and verifying features - Removed the "wheel install" and "wheel installscripts" commands +- Added the ``wheel pack`` command **0.31.1** diff --git a/docs/reference/index.rst b/docs/reference/index.rst index a688c63..1921323 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,3 +6,4 @@ Reference Guide wheel_convert wheel_unpack + wheel_pack diff --git a/docs/reference/wheel_pack.rst b/docs/reference/wheel_pack.rst new file mode 100644 index 0000000..7854f97 --- /dev/null +++ b/docs/reference/wheel_pack.rst @@ -0,0 +1,39 @@ +wheel repack +============ + +Usage +----- + +:: + + wheel repack <wheel_directory> + + +Description +----------- + +Repack a previously unpacked wheel file. + +This command can be used to repack a wheel file after its contents have been modified. +This is the equivalent of ``zip -r <wheel_file> <wheel_directory>`` except that it regenerates the +``RECORD`` file which contains hashes of all included files. + + +Options +------- + +.. option:: -d, --dest-dir <dir> + + Directory to put the new wheel file into. + + +Examples +-------- + +* Unpack a wheel, add a dummy module and then repack it:: + + $ wheel unpack someproject-1.5.0-py2-py3-none.whl + Unpacking to: ./someproject-1.5.0 + $ touch someproject-1.5.0/somepackage/module.py + $ wheel repack someproject-1.5.0 + Repacking wheel as ./someproject-1.5.0-py2-py3-none.whl...OK |