Projects & pyproject.toml
Projects are located in the projects folder of a Polylith workspace. Each project has its own pyproject.toml
,
where dependencies and project-specific things are defined. Just as in a mainstream Poetry or Hatch project.
What differs is how the Polylith components and bases (aka bricks) are referenced.
Poetry
Bricks are added in the tool.poetry section as packages:
[tool.poetry]
name = "my_example_project"
packages = [
{include = "my_namespace/my_base", from = "../../bases"},
{include = "my_namespace/my_component", from = "../../components"},
{include = "my_namespace/my_other_component", from = "../../components"}
]
Note the from attribute, where the base and components are referenced with relative paths.
The bases
and components
folders are located at the workspace root.
The project-specific pyproject.toml
file is located in a subfolder of the projects
folder.
Hatch
The pyproject.toml in the Workspace (i.e. the one in the root folder)
Add the polylith-cli
to the workspace pyproject.toml
configuration.
[tool.hatch.envs.default]
type = "virtual"
path = ".venv"
python = "3.12" # your preferred version here
Make Hatch aware of the Polylith structure:
The project-specific pyproject.toml file(s)
[build-system]
requires = ["hatchling", "hatch-polylith-bricks"]
build-backend = "hatchling.build"
[tool.hatch.build.hooks.polylith-bricks]
# this section is needed to enable the hook in the build process, even if empty.
Polylith bricks are added in the [tool.polylith.bricks]
section:
[tool.polylith.bricks]
"../../bases/my_namespace/my_base" = "my_namespace/my_base"
"../../components/my_namespace/my_component" = "my_namespace/my_component"
"../../components/my_namespace/my_other_component" = "my_namespace/my_other_component"
PDM
The pyproject.toml in the Workspace (i.e. the one in the root folder)
Add the workspace
PDM build hook:
The project-specific pyproject.toml file(s)
Add the project
PDM build hook:
Polylith bricks are added in the [tool.polylith.bricks]
section:
[tool.polylith.bricks]
"../../bases/my_namespace/my_base" = "my_namespace/my_base"
"../../components/my_namespace/my_component" = "my_namespace/my_component"
"../../components/my_namespace/my_other_component" = "my_namespace/my_other_component"
Rye
The pyproject.toml in the Workspace (i.e. the one in the root folder)
Add the polylith-cli
to the workspace pyproject.toml
configuration.
Add it manually, or by running rye add polylith-cli --dev
:
The default build backend for Rye is Hatch.
Make Rye (and Hatch) aware of the way Polylith organizes source code:
The project-specific pyproject.toml file(s)
Add the hatch-polylith-bricks
build hook plugin to the pyproject.toml
file.
[build-system]
requires = ["hatchling", "hatch-polylith-bricks"]
build-backend = "hatchling.build"
[tool.hatch.build.hooks.polylith-bricks]
# this section is needed to enable the hook in the build process, even if empty.
Polylith bricks are added in the [tool.polylith.bricks]
section:
[tool.polylith.bricks]
"../../bases/my_namespace/my_base" = "my_namespace/my_base"
"../../components/my_namespace/my_component" = "my_namespace/my_component"
"../../components/my_namespace/my_other_component" = "my_namespace/my_other_component"
The bases
and components
folders are located at the workspace root.
The project-specific pyproject.toml
file is located in a subfolder of the projects
folder.
uv
The pyproject.toml in the Workspace (i.e. the one in the root folder)
Add the polylith-cli
to the workspace pyproject.toml
configuration.
Add it manually, or by running uv add polylith-cli --dev
:
The default build backend for uv is Hatch.
Make uv (and Hatch) aware of the way Polylith organizes source code:
The project-specific pyproject.toml file(s)
Add the hatch-polylith-bricks
build hook plugin to the pyproject.toml
file.
[build-system]
requires = ["hatchling", "hatch-polylith-bricks"]
build-backend = "hatchling.build"
[tool.hatch.build.hooks.polylith-bricks]
# this section is needed to enable the hook in the build process, even if empty.
Polylith bricks are added in the [tool.polylith.bricks]
section:
[tool.polylith.bricks]
"../../bases/my_namespace/my_base" = "my_namespace/my_base"
"../../components/my_namespace/my_component" = "my_namespace/my_component"
"../../components/my_namespace/my_other_component" = "my_namespace/my_other_component"
The bases
and components
folders are located at the workspace root.
The project-specific pyproject.toml
file is located in a subfolder of the projects
folder.