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

Installing CLI with setuptools style "scripts" vs "console_scripts". #1023

Closed
1 of 2 tasks
grabear opened this issue Apr 8, 2019 · 10 comments
Closed
1 of 2 tasks

Installing CLI with setuptools style "scripts" vs "console_scripts". #1023

grabear opened this issue Apr 8, 2019 · 10 comments
Labels
kind/feature Feature requests/implementations

Comments

@grabear
Copy link

grabear commented Apr 8, 2019

  • I have searched the issues of this repo and believe that this is not a duplicate.
    This is definitely a duplicate, but the Feature Request is different.
  • I have searched the documentation and believe that my question is not covered.

Feature Request

It would be nice to install files as command line scripts vs installing modules as command line console_scripts.

The current ability of poetry to include "scripts" seems slightly misleading according to the setuptools documentation. I could be wrong, but it seems like the [tools.poetry.scripts] toml keyword should read more like [tools.poetry.console_scripts] or [tools.poetry.entry_points].

So I would like to request some clarity around this terminology in the documentation, as well as the implementation of setuptools style scripts.

I believe #241 (comment) addresses this as well. An associated PR is also open in #304

cc: @ojii

Thanks to any contributors to this project. It's an amazing tools that I'm excited to continue using.

Cheers,
@grabear

@grabear
Copy link
Author

grabear commented Apr 8, 2019

It's also not super clear in the documentation what the difference is between 'plugins' and 'scripts'.
Based on the original comment:

  • poetry's scripts == setuptools' entrypoint/console_script
  • setuptools' scripts keyword != poetry (is not represented by poetry)

And new information:

By changing the link in the 'plugins' documentation to the one supplied above, I think that would also help clear things up:

From this (main page of setuptools) to this (the actual article).

@ojii
Copy link
Contributor

ojii commented Apr 9, 2019

I could bring my PR up to date if there is a consensus on the config syntax and if this is something that poetry wants to support. I've stopped working on it because the discussion in the original ticket got way out of scope so I lost interest and found other workarounds to solve my use case.

@tedmiston
Copy link

I agree the Poetry docs would benefit from clarity around these topics. My confusion was similar to @grabear until ending up on a few issues like this.

@funkyfuture
Copy link
Contributor

yeah, it seems that a good load of topic-related issues opened here stem from that semantic twist.

@grabear
Copy link
Author

grabear commented Oct 9, 2019

@tedmiston @funkyfuture I'm glad I'm not the only one that was confused. I still have to come back to this issue sometimes to refresh my understanding of it all. @sdispater are there any developments surrounding this issue as well as related issues? #241 (comment) and #304

@stale
Copy link

stale bot commented Dec 8, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Dec 8, 2019
@finswimmer finswimmer added kind/feature Feature requests/implementations and removed stale labels Dec 8, 2019
@grabear
Copy link
Author

grabear commented Dec 9, 2019

This is definitely not a stale issue..

@geckon
Copy link

geckon commented Feb 28, 2020

For the record check #1504

@finswimmer
Copy link
Member

I think this is solved by python-poetry/poetry-core#40

Copy link

github-actions bot commented Mar 1, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/feature Feature requests/implementations
Projects
None yet
Development

No branches or pull requests

6 participants