Skip to content

Commit

Permalink
packaged app: use executable named for the project and main function (#…
Browse files Browse the repository at this point in the history
…7670)

## 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

- existing tests are updated
  • Loading branch information
bluss authored Sep 30, 2024
1 parent 04c79af commit 67769a4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions crates/uv/src/commands/project/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ impl InitProjectKind {
if package {
// Since it'll be packaged, we can add a `[project.scripts]` entry
pyproject.push('\n');
pyproject.push_str(&pyproject_project_scripts(name, "hello", "hello"));
pyproject.push_str(&pyproject_project_scripts(name, name.as_str(), "main"));

// Add a build system
pyproject.push('\n');
Expand All @@ -618,7 +618,7 @@ impl InitProjectKind {
fs_err::write(
init_py,
indoc::formatdoc! {r#"
def hello() -> None:
def main() -> None:
print("Hello from {name}!")
"#},
)?;
Expand Down
12 changes: 6 additions & 6 deletions crates/uv/tests/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ fn init_application_package() -> Result<()> {
dependencies = []
[project.scripts]
hello = "foo:hello"
foo = "foo:main"
[build-system]
requires = ["hatchling"]
Expand All @@ -297,13 +297,13 @@ fn init_application_package() -> Result<()> {
}, {
assert_snapshot!(
init, @r###"
def hello() -> None:
def main() -> None:
print("Hello from foo!")
"###
);
});

uv_snapshot!(context.filters(), context.run().current_dir(&child).arg("hello"), @r###"
uv_snapshot!(context.filters(), context.run().current_dir(&child).arg("foo"), @r###"
success: true
exit_code: 0
----- stdout -----
Expand Down Expand Up @@ -1621,7 +1621,7 @@ fn init_virtual_project() -> Result<()> {
dependencies = []
[project.scripts]
hello = "foo:hello"
foo = "foo:main"
[build-system]
requires = ["hatchling"]
Expand Down Expand Up @@ -1655,7 +1655,7 @@ fn init_virtual_project() -> Result<()> {
dependencies = []
[project.scripts]
hello = "foo:hello"
foo = "foo:main"
[build-system]
requires = ["hatchling"]
Expand Down Expand Up @@ -1750,7 +1750,7 @@ fn init_nested_virtual_workspace() -> Result<()> {
dependencies = []
[project.scripts]
hello = "foo:hello"
foo = "foo:main"
[build-system]
requires = ["hatchling"]
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ example-packaged-app
But the module defines a CLI function:

```python title="__init__.py"
def hello() -> None:
def main() -> None:
print("Hello from example-packaged-app!")
```

Expand All @@ -247,7 +247,7 @@ requires-python = ">=3.11"
dependencies = []

[project.scripts]
hello = "example_packaged_app:hello"
example-packaged-app = "example_packaged_app:main"

[build-system]
requires = ["hatchling"]
Expand All @@ -257,7 +257,7 @@ build-backend = "hatchling.build"
Which can be executed with `uv run`:

```console
$ uv run hello
$ uv run example-packaged-app
Hello from example-packaged-app!
```

Expand Down

0 comments on commit 67769a4

Please sign in to comment.