Support for script-files

[petrprikryl]

Hi, are there any plans for script-files support like in setuptools tool.setuptools.script-files? E.g. for shell scripts.

Maybe useful:

• https://discuss.python.org/t/are-python-package-developers-just-not-supposed-to-package-shell-scripts-as-a-general-practice/25665
• https://docs.python.org/3.11/distutils/setupscript.html#installing-scripts
• Improve script section: support use of script files python-poetry/poetry#2310

[charliermarsh]

@konstin -- Would this be part of the build backend work (eventually), or is it separate?

[konstin]

Yes, adding scripts is part of the build backend configuration (there is a dedicated scripts folder in wheels).

[BenConstable9]

Is there any plan for this?

I would like to move from Poetry to UV but this is blocking it for one of my projects.

I would like the equivalent of: tool.poetry.scripts

[my1e5]

@BenConstable9 - I believe [project.scripts] which is part of the official pyproject.toml specification will cover the functionality you are looking for? See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#creating-executable-scripts

Also Using uv run as a task runner might be relevant?

[zanieb]

Note that packages using script-files have been the cause of various bug reports already. That may affect its inclusion in our build backend? I'm not familiar with the state of the standards there though.

The [project.scripts] table is the recommended way to create cross-platform scripts. You can use that today https://docs.astral.sh/uv/concepts/projects/config/#command-line-interfaces (and you can also use setuptools and script-files with uv)

[konstin]

There are three different features known as "scripts":

• project.scripts and project.gui-scripts: These are standards that should be supported by every build backend, and will also be supported by uv's build backend (Build backend: Add integration test for scripts #9635). Note that they already work with any build backend you're using: After installing the package, the scripts are installed and added to PATH by uv run or virtual environment activation. Poetry calls those tool.poetry.scripts.
• The scripts data folder. Similar to project.scripts and project.gui-scripts, they are standards and already supported if your build backend uses them . The difference to project.scripts is that they aren't generated on installation, but just files copied to the correct target, so they are less portable.
• A task runner, such as Using uv run as a task runner #5903

If you move from poetry to uv, you currently need to configure this for the build backend your using, not in uv itself.

[BenConstable9]

Thank you all. I had somehow missed this in the documentation. I will look to use it.