pdm icon indicating copy to clipboard operation
pdm copied to clipboard

docs: Explain a difference between project.scripts and tool.pdm.scripts

Open Fak3 opened this issue 2 years ago • 6 comments

Is your feature request related to a problem? Please describe.

In the current "usage" section of documentation, I struggled to find any information on how to build a package which provides executable python script. There is currently a section called "pdm scripts": https://pdm.fming.dev/latest/usage/scripts/, which does not explain clearly that [tool.pdm.scripts] are not installed when someone else installs your package with pip.

Describe the solution you'd like

It would be helpful to add a note that pdm scripts are different from [project.scripts]. Having a note on top of https://pdm.fming.dev/latest/usage/scripts/ page would help to avoid confusion. For someone looking for installable console scripts, this note can provide a link to appropriate reference documentation: https://pdm.fming.dev/latest/reference/pep621/#console-scripts

Fak3 avatar Jul 21 '23 05:07 Fak3

Would you like to contribute that?

frostming avatar Jul 21 '23 05:07 frostming

Ok, I'll try to create a pull request

Fak3 avatar Jul 21 '23 05:07 Fak3

Hi, is this issue being worked on? If anyone needs, I'd gladly help out.

baggiponte avatar Jan 21 '24 21:01 baggiponte

@baggiponte feel free to pick it up.

frostming avatar Jan 22 '24 02:01 frostming

Thanks. I think I will add a callout/admonition below this section redirecting to the pypa pyproject.toml spec. WDYT?

baggiponte avatar Jan 22 '24 08:01 baggiponte

@baggiponte No objection, but you don't need to ask, just submit a pull request and I will leave comments.

frostming avatar Jan 23 '24 01:01 frostming