Skip to content

Commit

Permalink
Add project docs for project.scripts (#7010)
Browse files Browse the repository at this point in the history
Closes #6998

Common point of confusion because Poetry defines these in
`tool.poetry.scripts`
  • Loading branch information
zanieb authored Sep 4, 2024
1 parent 5cc7667 commit b2cb3bb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/concepts/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,22 @@ definitions with [package sources](./dependencies.md) in `tool.uv.sources`.

See the official [`pyproject.toml` guide](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/) for more details on getting started with a `pyproject.toml`.

## Defining entry points

uv uses the standard `[project.scripts]` table to define entry points for the project.

For example, to declare an command called `hello` that invokes the `hello` function in the
`example_package_app` module:

```toml title="pyproject.toml"
[project.scripts]
hello = "example_package_app:hello"
```

!!! important

Using `[project.scripts]` requires a [build system](#build-systems) to be defined.

## Build systems

Projects _may_ define a `[build-system]` in the `pyproject.toml`. The build system defines how the
Expand Down

0 comments on commit b2cb3bb

Please sign in to comment.