Skip to content

Commit

Permalink
Improve the project creation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zanieb committed Nov 19, 2024
1 parent 62e0ee7 commit 668b243
Show file tree
Hide file tree
Showing 2 changed files with 173 additions and 105 deletions.
16 changes: 16 additions & 0 deletions docs/concepts/projects/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@ the source code are reflected immediately, without re-installation.

## Project packaging

As discussed in [build systems](#build-systems), a Python project must be built to be installed.
This process is generally referred to as "packaging".

You probably need a package if you want to:

- Add commands to the project
- Distribute the project to others
- Use a `src` and `test` layout
- Write a library

You probably _do not_ need a package if you are:

- Writing scripts
- Building a simple application
- Using a flat layout

While uv usually uses the declaration of a [build system](#build-systems) to determine if a project
should be packaged, uv also allows overriding this behavior with the
[`tool.uv.package`](../../reference/settings.md#package) setting.
Expand Down
Loading

0 comments on commit 668b243

Please sign in to comment.