Skip to content

Improve note about build system in publish guide #16788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zanieb merged 1 commit into from
Nov 20, 2025
Merged

Improve note about build system in publish guide #16788

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/guides/package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ description: A guide to using uv to build and publish Python packages to a packa
uv supports building Python packages into source and binary distributions via `uv build` and
uploading them to a registry with `uv publish`.

## Preparing your project for packaging
## Preparing your project

Before attempting to publish your project, you'll want to make sure it's ready to be packaged for
distribution.

If your project does not include a `[build-system]` definition in the `pyproject.toml`, uv will not
build it by default. This means that your project may not be ready for distribution. Read more about
the effect of declaring a build system in the
[project concept](../concepts/projects/config.md#build-systems) documentation.
build it during `uv sync` operations in the project, but will fall back to the legacy setuptools
Copy link
Copy Markdown
Member

@konstin konstin Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user that said that we have the fallback behavior is technically correct, and we do build if there's a workspace member (or any other package) without build system with another workspace member depending on it, but the real answer is that you really want to configure a build system, so I'm not worried about this being technically wrong.

Copy link
Copy Markdown
Member Author

@zanieb zanieb Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, thanks for the clarification

build system during `uv build`.

We strongly recommend configuring a build system. Read more about build systems in the
[project configuration](../concepts/projects/config.md#build-systems) documentation.

!!! note

Expand Down
Loading