search

pdm-project / pdm

A modern Python package and dependency manager supporting the latest PEP standards
https://pdm-project.org
MIT License
7.81k stars 386 forks source link

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

Closed Fak3 closed 6 months ago

Fak3 commented 1 year ago

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

frostming commented 1 year ago

Would you like to contribute that?

Fak3 commented 1 year ago

Ok, I'll try to create a pull request

baggiponte commented 8 months ago

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

frostming commented 8 months ago

@baggiponte feel free to pick it up.

baggiponte commented 8 months ago

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

frostming commented 8 months ago

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