Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add project docs for `project.scripts` (#7010) 

Closes https://github.com/astral-sh/uv/issues/6998

Common point of confusion because Poetry defines these in
`tool.poetry.scripts`
This commit is contained in:
Zanie Blue 2024-09-04 12:16:31 -05:00 committed by GitHub
parent 5cc76679e9
commit b2cb3bb2ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/concepts/projects.md
View File

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