Commit bfdc7152 authored by Gaëtan Montury's avatar Gaëtan Montury
Browse files

docs: update uv tips 

fix issue https://gitlab.com/to-be-continuous/doc/-/issues/43
parent 8caa10a3

README.md

+6 −3
Original line number Diff line number Diff line
@@ -138,10 +138,13 @@ It is bound to the `build` stage, it is **disabled by default** and can be enabl 


#### UV tip



Currently, UV supports the following underlying build systems:



- [hatchling](https://pypi.org/project/hatchling/) (this is the default setting when creating a new project with UV), so you may use the same build configuration as [Hatch](https://hatch.pypa.io/latest/build/). The recommended file layout is [`src-layout`](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) to simplify [finding the source](https://hatch.pypa.io/latest/plugins/builder/wheel/#default-file-selection) otherwise configure [Hatch build config](https://hatch.pypa.io/latest/config/build/).

- or [setuptools](https://pypi.org/project/setuptools/) (this is the default if nothing is defined in your `pyproject.toml`). In this case, the recommended file layout is also [`src-layout`](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/), otherwise configure [`package_discovery`](https://setuptools.pypa.io/en/latest/userguide/package_discovery.html).

UV supports multiple [build backends](https://docs.astral.sh/uv/concepts/projects/config/#build-systems):



- [uv_build](https://docs.astral.sh/uv/concepts/build-backend/) — UV's native backend, default with `uv init --lib`. Zero-config, **pure Python only**, uses [`src-layout`](https://docs.astral.sh/uv/concepts/build-backend/#modules).

- [hatchling](https://pypi.org/project/hatchling/) — for flexible layouts or build scripts. See [Hatch build config](https://hatch.pypa.io/latest/config/build/). Recommended: [`src-layout`](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) to simplify [finding the source](https://hatch.pypa.io/latest/plugins/builder/wheel/#default-file-selection) otherwise configure [Hatch build config](https://hatch.pypa.io/latest/config/build/).

- [setuptools](https://pypi.org/project/setuptools/) — fallback when no build system is defined. Use [`src-layout`](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) or configure [`package_discovery`](https://setuptools.pypa.io/en/latest/userguide/package_discovery.html).





### Lint jobs