📝 docs: document pipx.run entry point group#1745
Merged
gaborbernat merged 1 commit intopypa:mainfrom Mar 18, 2026
Merged
Conversation
Package authors whose console script name differs from the package name can declare a pipx.run entry point so that pipx run PACKAGE works without --spec. Added pyproject.toml and setup.cfg examples to the making-packages-compatible explanation page and a cross-reference from the run-applications tutorial.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Package authors whose console script name differs from the package name have to tell users to run
pipx run --spec PACKAGE SCRIPT. Thepipx.runentry point group lets authors declare which functionpipx run PACKAGEshould invoke, avoiding the need for--spec. This feature has existed since v0.16.1.0 but was never documented.Added
pyproject.tomlandsetup.cfgexamples to the making-packages-compatible explanation page, withbuildas a real-world reference. The run-applications tutorial now cross-references this section where it explains--specusage.Closes #1371