Skip to content

gitversioned.plugins.maturin_plugin

Maturin build backend wrapper for GitVersioned.

This module implements PEP 517 and PEP 660 build backend hooks to integrate dynamic version resolution into Rust-based Python packages. When a build frontend (such as pip or build) invokes this backend, the wrapper calculates the project version using Git repository metadata and configuration, updates Cargo.toml if necessary, and then invokes the corresponding Maturin backend hook to compile and package the project.

The main interfaces correspond to PEP 517/660 hooks, which automatically locate, configure, and invoke the underlying maturin implementation while transparently managing the logging setup and build environment configuration.

build_editable(wheel_directory, config_settings=None, metadata_directory=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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,
    )

build_sdist(sdist_directory, config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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,
    )

build_wheel(wheel_directory, config_settings=None, metadata_directory=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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,
    )

get_requires_for_build_editable(config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
    )

get_requires_for_build_sdist(config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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)

get_requires_for_build_wheel(config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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)

prepare_metadata_for_build_editable(metadata_directory, config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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,
    )

prepare_metadata_for_build_wheel(metadata_directory, config_settings=None)

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.

Source code in src/gitversioned/plugins/maturin_plugin.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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,
    )