Build Backend Plugin

You can even use this plugin without PDM. This is enabled by build backend hooks.

Currently, both pdm-backend and hatchling are supported.

To set it up, a few configuration steps are required.

Lockfile configuration

Your lockfile must be configured with the inherit_metadata strategy (pdm>=2.11) and include locks for the optional-dependencies groups you want to publish locked.

Note

When running pdm lock, ensure you select the appropriate dependency groups.

For instance, you can use pdm lock -G :all and then verify that the [metadata] section of the pdm.lock file includes the desired groups. For more details, refer to the Dependencies Selection: section in the pdm lock --help output.

buildsystem configuration

This step depends on the build-system you use and requires you to add the following to your pyproject.toml.

pdm-backend

pyproject.toml

[build-system]
requires = ["pdm-backend", "pdm-build-locked"]
build-backend = "pdm.backend"

[tool.pdm.build]
locked = true

hatchling

pyproject.toml

[build-system]
requires = ["hatchling", "pdm-build-locked"]
build-backend = "hatchling.build"

[tool.hatch.metadata.hooks.build-locked]

Select groups to lock

By default, the default group and all optional groups will be locked, but you can specify the groups to lock by setting locked-groups in the configuration.

pyproject.toml

# for pdm-backend
[tool.pdm.build]
locked = true
locked-groups = ["default", "optional1"]

# for hatchling
[tool.hatch.metadata.hooks.build-locked]
locked-groups = ["default", "optional1"]