Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support GUI applications (make "gui_scripts" known to pipx) #711

Open
fladd opened this issue Jun 30, 2021 · 5 comments
Open

Support GUI applications (make "gui_scripts" known to pipx) #711

fladd opened this issue Jun 30, 2021 · 5 comments
Labels
docs good first issue Good for newcomers help wanted Extra attention is needed

Comments

@fladd
Copy link

fladd commented Jun 30, 2021

How would this feature be useful?

The documentation on how pipx works (https://pypa.github.io/pipx/how-pipx-works/) suggests that only functions defined in entry_points as console_scripts are available to pipx after installation.
Having functions defined as gui_scripts available, too, would allow to use pipx for GUI applications.

Describe the solution you'd like

When gui_scripts are defined as entry_points in setup.py, pipx should make those available as known commands on the system.

Describe alternatives you've considered

The alternative seems to be to specify GUI applications as console_scripts, which would always open a terminal when run from a place other than a terminal.

@uranusjr uranusjr added the enhancement New feature or request label Jun 30, 2021
@uranusjr
Copy link
Member

Sounds like a perfectly valid usage to me. Would you be interested in contributing a PR for this?

@fladd
Copy link
Author

fladd commented Jun 30, 2021

I just had a look at the actual code, and it seems that pipx already considers gui_scripts (

sections = {"console_scripts", "gui_scripts"}
). I haven't verified this yet, but maybe the documentation is just confusing on this?

@uranusjr
Copy link
Member

It could be, I’m not familiar with the exact behaviour either. Could you try locally whether gui_scripts are indeed correctly handled already, and if so, draft some documentation fixes?

@gaborbernat gaborbernat added the help wanted Extra attention is needed label Dec 2, 2023
@gaborbernat
Copy link
Contributor

PR welcome.

@Gitznik
Copy link
Contributor

Gitznik commented Feb 4, 2024

I just validated that pipx exposes gui_scripts via pipx install novelwriter -> novelwriter.

Should just be a matter of improving the docs.

@Gitznik Gitznik added docs good first issue Good for newcomers and removed enhancement New feature or request labels Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants