gitversioned.integrations.maturin¶

def build_editable(
    wheel_directory: str,
    config_settings: dict[str, Any] | None = None,
    metadata_directory: str | None = None,
) -> str:
    """
    Build an editable wheel, delegating to maturin.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        path = maturin_plugin.build_editable("dist/")

    :param wheel_directory: Directory where the editable wheel
        should be written.
    :param config_settings: Configuration options passed by the
        build frontend.
    :param metadata_directory: Optional directory containing
        pre-built metadata.
    :returns: The filename of the built editable wheel.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().build_editable(
        wheel_directory,
        config_settings=config_settings,
        metadata_directory=metadata_directory,
    )

def build_sdist(
    sdist_directory: str,
    config_settings: dict[str, Any] | None = None,
) -> str:
    """
    Build a source distribution (sdist), delegating packaging to maturin.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        path = maturin_plugin.build_sdist("dist/")

    :param sdist_directory: Directory where the constructed sdist
        should be written.
    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: The filename of the built sdist.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().build_sdist(
        sdist_directory,
        config_settings=config_settings,
    )

def build_wheel(
    wheel_directory: str,
    config_settings: dict[str, Any] | None = None,
    metadata_directory: str | None = None,
) -> str:
    """
    Build a wheel, delegating compilation and packaging to maturin.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        path = maturin_plugin.build_wheel("dist/")

    :param wheel_directory: Directory where the constructed wheel
        should be written.
    :param config_settings: Configuration options passed by the
        build frontend.
    :param metadata_directory: Optional directory containing
        pre-built metadata.
    :returns: The filename of the built wheel.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().build_wheel(
        wheel_directory,
        config_settings=config_settings,
        metadata_directory=metadata_directory,
    )

def get_requires_for_build_editable(
    config_settings: dict[str, Any] | None = None,
) -> list[str]:
    """
    Get additional packages required to build an editable wheel.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        reqs = maturin_plugin.get_requires_for_build_editable()

    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: A list of dependency specification strings.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().get_requires_for_build_editable(
        config_settings=config_settings
    )

def get_requires_for_build_sdist(
    config_settings: dict[str, Any] | None = None,
) -> list[str]:
    """
    Get additional packages required to build a source distribution (sdist).

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        reqs = maturin_plugin.get_requires_for_build_sdist()

    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: A list of dependency specification strings.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().get_requires_for_build_sdist(config_settings=config_settings)

def get_requires_for_build_wheel(
    config_settings: dict[str, Any] | None = None,
) -> list[str]:
    """
    Get additional packages required to build a wheel.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        reqs = maturin_plugin.get_requires_for_build_wheel()

    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: A list of dependency specification strings.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().get_requires_for_build_wheel(config_settings=config_settings)

def prepare_metadata_for_build_editable(
    metadata_directory: str,
    config_settings: dict[str, Any] | None = None,
) -> str:
    """
    Prepare the dist-info metadata directory for an editable wheel build.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        path = maturin_plugin.prepare_metadata_for_build_editable("metadata/")

    :param metadata_directory: Directory where the metadata should
        be written.
    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: The basename of the metadata directory.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().prepare_metadata_for_build_editable(
        metadata_directory,
        config_settings=config_settings,
    )

def prepare_metadata_for_build_wheel(
    metadata_directory: str,
    config_settings: dict[str, Any] | None = None,
) -> str:
    """
    Prepare the dist-info metadata directory for a wheel build.

    .. code-block:: python

        from gitversioned.plugins import maturin_plugin

        path = maturin_plugin.prepare_metadata_for_build_wheel("metadata/")

    :param metadata_directory: Directory where the metadata should
        be written.
    :param config_settings: Configuration options passed by the
        build frontend.
    :returns: The basename of the metadata directory.
    :raises ImportError: If the maturin package is not installed.
    """
    return _get_maturin().prepare_metadata_for_build_wheel(
        metadata_directory,
        config_settings=config_settings,
    )