Change the primary name of the console script to setuptools-pyproject-migration #127
Conversation
This file contains 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
In this commit I'm changing the primary name of the console script to match the name of the package, setuptools-pyproject-migration. This will allow people to run the program directly with pipx run setuptools-pyproject-migration without an explicit installation step. We could keep both console script names, but I think that's going to be more confusion than it's worth, so I've marked the old name setup-to-pyproject as deprecated. This was simply done by writing a wrapper function that issues a FutureWarning and redirecting the old console script name to call it. (Our users don't need anything fancy.)
I added a couple tests to verify that the deprecated script emits the expected FutureWarning and that it invokes the plugin. Since the plan is to remove this console script name after a while, I didn't bother to write extensive tests for it.
|
I know we had a bit of discussion about this on the issue so I'm happy to iterate on this change if we could/should be doing it a different way. |
sjlongland
approved these changes
Dec 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR changes the name of the console script that users should use to match the name of the package,
setuptools-pyproject-migration, to supportpipx run.We could have kept multiple console script names, but I thought that was more confusion than it's worth.
The intent will be to remove the old console script name in some future version, though I'm not sure if it makes sense to advertise a specific version in which it will be removed or how long we should wait before actually removing it. (Especially given that it didn't even seem to work properly, see #100)
Closes #107