packaged app: use executable named for the project and main function #7670
+11
−11
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
bluss
commented
Sep 24, 2024
| @@ -1423,7 +1423,7 @@ fn init_virtual_project() -> Result<()> { | |||
| dependencies = [] | |||
|
|
|||
| [project.scripts] | |||
| hello = "foo:hello" | |||
| foo = "foo:main" | |||
There was a problem hiding this comment.
Maybe I'm mistaken here, but I think this test shows that uv init --virtual is already creating something with a build system and executable, this is fishy.
There was a problem hiding this comment.
Yeah this is fishy — --virtual is legacy now but shouldn't be doing this. Let's tackle it separately though.
bluss
changed the title
bluss
changed the title
zanieb
reviewed
Sep 24, 2024
docs/concepts/projects.md
Outdated
| @@ -247,7 +247,7 @@ requires-python = ">=3.11" | |||
| dependencies = [] | |||
|
|
|||
| [project.scripts] | |||
| hello = "example_packaged_app:hello" | |||
| example-packaged-app = "example_packaged_app:hello" | |||
There was a problem hiding this comment.
oops, fixed.
Also I'm very used to force pushing but shouldn't do that since you squash merge here anyway. I just haven't learned the lesson yet..
There was a problem hiding this comment.
Oh we force push all the time, don't worry about that.
Create a function main as the default for a packaged app. Configure the default executable as: example-packaged-app = "example_packaged_app:main" Which is often what you want - the executable has the same name as the app.
|
I'm off today but I'll try to get this in early next week. |
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.
Summary
Create a function main as the default for a packaged app. Configure the default executable as:
example-packaged-app = "example_packaged_app:main"Which is often what you want - the executable has the same name as the app.
The purpose is to more often hit what the user wants, so they don't have
to even rename the command to start developing.
Test Plan