python.wheel
============

.. py:module:: python.wheel


Classes
-------

.. autoapisummary::

   python.wheel.WheelError
   python.wheel.Wheel


Module Contents
---------------

.. py:class:: WheelError

   Bases: :py:obj:`e3.error.E3Error`


.. py:class:: Wheel(path: str)

   Handle Python wheel packages.


   .. py:attribute:: path
      :value: b'.'



   .. py:property:: metadata_path
      :type: str


      Relative path in a wheel package to the metadata.



   .. py:property:: requirements
      :type: set[packaging.requirements.Requirement]


      Return the set of Requirements for the wheel.



   .. py:method:: build(source_dir: str, dest_dir: str, python_tag: str = 'py3', build_args: list[str] | None = None) -> Wheel
      :classmethod:


      Create a wheel package from a source directory.

      :param source_dir: location of the sources
      :param dest_dir: directory in which the wheel will be saved
      :param python_tag: python tag (default: py3)
      :param build_args: extra `pip wheel` build arguments
      :return: a Wheel object



   .. py:method:: install() -> None

      Install a wheel.



