Make project require a pdm plugin

[hmoffatt]

Is it possible to declare a requirement for a pdm plugin to be installed, in pyproject.yml?

I would like to ensure that for example pdm-autoexport is always installed (to keep requirements.txt up to date), and also pdm-audit.

[frostming]

It is possible but requires a separate installation step: https://pdm-project.org/en/latest/dev/write/#specify-the-plugins-in-project

[hmoffatt]

Sorry I didn't understand which bit, or how to use it?

I already have the following in my project file (based on https://pdm-project.org/en/latest/dev/write/#specify-the-plugins-in-project), but pdm doesn't complain if these plugins aren't installed:

[tool.pdm]
plugins = [
    "pdm-autoexport",
    "pdm-audit"
]

[frostming]

You need to install it yourself:

pdm install --plugins

[hmoffatt]

I was hoping that pdm would complain if the plugins are missing. Otherwise, with pdm-autoexport missing, the lock file and requirements.txt silently get out of sync.

[frostming]

I was hoping that pdm would complain if the plugins are missing.

It's not possible, but you can ensure they are installed with script hooks, like:

[tool.pdm.scripts]
post_install = "{pdm} install --plugins"

Then plugins will be installed each time you run pdm sync or pdm install

[hmoffatt]

Thanks. I think perhaps it's easier to run pdm export directly from the post_install or post_lock script rather than use the plugin then.