diff options
| author | Alex Grönholm <alex.gronholm@nextday.fi> | 2018-05-26 16:01:58 +0300 |
|---|---|---|
| committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2018-07-17 15:02:49 +0300 |
| commit | 70ff4db98ae6a534bc04a59f28d5a29ac4c80e84 (patch) | |
| tree | 3107877cde28eb907c86da676b2389dbf5523258 | |
| parent | e9d0b15468ddd78d7bfb23b3a729a2c05a908798 (diff) | |
| download | wheel-git-70ff4db98ae6a534bc04a59f28d5a29ac4c80e84.tar.gz | |
Removed all documentation references to the signing features
| -rw-r--r-- | docs/installing.rst | 9 | ||||
| -rw-r--r-- | docs/quickstart.rst | 19 | ||||
| -rw-r--r-- | docs/reference/index.rst | 4 | ||||
| -rw-r--r-- | docs/reference/wheel_keygen.rst | 37 | ||||
| -rw-r--r-- | docs/reference/wheel_unsign.rst | 39 | ||||
| -rw-r--r-- | docs/reference/wheel_verify.rst | 40 | ||||
| -rw-r--r-- | docs/user_guide.rst | 31 | ||||
| -rw-r--r-- | manpages/wheel.rst | 23 |
8 files changed, 9 insertions, 193 deletions
diff --git a/docs/installing.rst b/docs/installing.rst index cb6547b..53a0f5d 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -8,11 +8,6 @@ You can use pip_ to install wheel:: If you do not have pip_ installed, see its documentation for `installation instructions`_. -If you intend to use wheel for sign wheels, you will need to include the -``signatures`` extra when using pip_ to install:: - - pip install wheel[signatures] - If you prefer using your system package manager to install Python packages, you can typically find the wheel package under one of the following package names: @@ -20,12 +15,8 @@ can typically find the wheel package under one of the following package names: * python2-wheel * python3-wheel -For the wheel signing dependencies, you will have to match the dependencies in -wheel's extras_require_ against your system packages to find the right ones. - .. _pip: https://pip.pypa.io/en/stable/ .. _installation instructions: https://pip.pypa.io/en/stable/installing/ -.. _extras_require: https://github.com/pypa/wheel/blob/master/setup.py Python and OS Compatibility --------------------------- diff --git a/docs/quickstart.rst b/docs/quickstart.rst index a8bd251..a8fe813 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -7,18 +7,17 @@ To build a wheel for your setuptools based project:: The wheel will go to ``dist/yourproject-<tags>.whl``. -To generate a key for signing wheels (you just need to do this **once**):: +If you want to make universal (Python 2/3 compatible, pure Python) wheels, add the following +section to your ``setup.cfg``:: - wheel keygen + [bdist_wheel] + universal = 1 -To sign a wheel file:: +To convert an ``.egg`` or file to a wheel:: - wheel sign yourwheelfile.whl - -To verify the signature of a signed wheel file:: - - wheel verify yourwheelfile.whl + wheel convert youreggfile.egg -To convert an ``.egg`` file to a wheel:: +Similarly, to convert a Windows installer (made using ``python setup.py bdist_wininst``) to a +wheel:: - wheel convert youreggfile.egg + wheel convert yourinstaller.exe diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 57a9d4f..660fb40 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -4,10 +4,6 @@ Reference Guide .. toctree:: :maxdepth: 2 - wheel_keygen - wheel_sign - wheel_verify - wheel_unsign wheel_convert wheel_install wheel_unpack diff --git a/docs/reference/wheel_keygen.rst b/docs/reference/wheel_keygen.rst deleted file mode 100644 index 73806c2..0000000 --- a/docs/reference/wheel_keygen.rst +++ /dev/null @@ -1,37 +0,0 @@ -wheel keygen -============ - -Usage ------ - -:: - - wheel keygen - - -Description ------------ - -Generates an ED25519 keypair for the purpose of signing wheels. - -Repeated invocations of this command will each add a new key to the keyring. -The latest key will always be used for signing wheels. - -Options -------- - -This command has no options. - - -Examples --------- - -:: - - $ wheel keygen - Created Ed25519 keypair with vk=ArGKRsTbmnMcO5aW2Of4xkictMrmUyxutJStwzlZcDk - in <PlaintextKeyring with no encyption v.1.0 at /home/alex/.local/share/python_keyring/keyring_pass.cfg> - Trusting ArGKRsTbmnMcO5aW2Of4xkictMrmUyxutJStwzlZcDk to sign and verify all packages. - -.. note:: The above key is not actually used to sign any wheels, so do not - trust it! diff --git a/docs/reference/wheel_unsign.rst b/docs/reference/wheel_unsign.rst deleted file mode 100644 index 419d467..0000000 --- a/docs/reference/wheel_unsign.rst +++ /dev/null @@ -1,39 +0,0 @@ -wheel unsign -============ - -Usage ------ - -:: - - wheel unsign <wheel_file> - - -Description ------------ - -Remove the digital signature from the given wheel file. - -This removes the ``RECORD.jws`` file from the end of the archive. - - -Options -------- - -This command has no options. - - -Examples --------- - -* Unsign a wheel:: - - $ wheel unsign someproject-X.Y.Z-py2-py3-none.whl - -* If the wheel isn't signed:: - - $ wheel unsign someproject-X.Y.Z-py2-py3-none.whl - The wheel is not signed (RECORD.jws not found at end of the archive). - $ echo $? - 1 - diff --git a/docs/reference/wheel_verify.rst b/docs/reference/wheel_verify.rst deleted file mode 100644 index 2a81f12..0000000 --- a/docs/reference/wheel_verify.rst +++ /dev/null @@ -1,40 +0,0 @@ -wheel verify -============ - -Usage ------ - -:: - - wheel verify <wheel_file> - - -Description ------------ - -Verify that the wheel's signature is internally consistent. - -This does not verify the files in the archive contents. For that, you must use -the ``wheel unpack`` or ``wheel install`` commands. - - -Options -------- - -This command has no options. - - -Examples --------- - -* Verify a wheel:: - - $ wheel verify someproject-X.Y.Z-py2-py3-none.whl - -* If the wheel is not signed:: - - $ wheel verify someproject-X.Y.Z-py2-py3-none.whl - The wheel is not signed (RECORD.jws not found at end of the archive). - $ echo $? - 1 - diff --git a/docs/user_guide.rst b/docs/user_guide.rst index dd6002b..7e3e999 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -22,37 +22,6 @@ adding this to your ``setup.cfg`` file: .. _setuptools: https://pypi.org/project/setuptools/ -Signing and Verifying Wheels ----------------------------- - -.. note:: For wheel signing to work, the appropriate dependencies must be - installed. See the :doc:`installing` section for more information. - -Wheels can be signed to help ensure that their contents have not been tampered -with after they were created. To sign a wheel, you must first have an ED25519 -keypair which can be generated as such:: - - $ wheel keygen - -This will generate and store a key pair on your hard drive. You do not normally -need to do this more than once. - -To sign an existing wheel file with this key:: - - $ wheel sign someproject-1.5.0-py2-py3-none.whl - -Verifying the signature in a wheel file can be done with following command:: - - $ wheel verify someproject-1.5.0-py2-py3-none.whl - -This will verify the internal consistency of the signature in the wheel file. -It will also print out the key algorithm, verification key and the hash of the -key. - -You can also use wheel to remove the signature from a wheel file:: - - $ wheel unsign someproject-1.5.0-py2-py3-none.whl - Converting Eggs to Wheels ------------------------- diff --git a/manpages/wheel.rst b/manpages/wheel.rst index 2669098..3e950a2 100644 --- a/manpages/wheel.rst +++ b/manpages/wheel.rst @@ -17,32 +17,9 @@ Description Commands -------- - ``keygen`` - Generate signing key - - ``sign`` - Sign wheel - - ``unsign`` - Remove ``RECORD.jws`` from a wheel by truncating the zip file. - ``RECORD.jws`` must be at the end of the archive. The zip file must be an - ordinary archive, with the compressed files and the directory in the same - order, and without any non-zip content after the truncation point. - - ``verify`` - Verify a wheel. The signature will be verified for internal consistency - *only* and printed. Wheel's own ``unpack`` and ``install`` commands - verify the manifest against the signature and file contents. - ``unpack`` Unpack wheel - ``install`` - Install wheels - - ``install-scripts`` - Install console scripts - ``convert`` Convert egg or wininst to wheel |
