Packaging & deploying
Poetry
Packaging and deploying Polylith projects is done by using the Poetry Multiproject plugin command (see installation).
The poetry build-project
command will make it possible to use relative package includes as how components and bases are added to Python Polylith projects.
Relative includes are currently not possible by default in Poetry, that is where the Multiproject plugin comes in.
Hatch, PDM, Rye and uv
Hatch, PDM, Rye and uv support relative includes via the [tool.poetry.bricks]
configuration.
Nothing extra needed other than the build hooks.
Building source distributions (sdist)?
If you will distribute an sdist
as the primary way to install your package,
you will need to add the path in the project-specific pyroject.toml
.
If you only provide wheel
distributions, this is optional.
Hatch, Rye and uv
PDM
Packaging
To collect the components and bases that are needed for a specific project, the tool introduces a build step. The tool will build a wheel and an sdist from the source code of a project.
This is the preferred way for Polylith projects.
Packaging a service or app
Poetry
Hatch
PDM
Rye
uv
This command will create a project specific dist folder containing a wheel with all the needed bricks.
Deploying
You can use the built artifacts to install your service in your preffered way, just by running
Packaging a Library
The Python tools for the Polylith Architecture has support for building libraries to be published at PyPI, even if it isn't the main use case.
Important note: by default, the code in one library will share the same top namespace with other libraries that are built from the same Polylith Monorepo. To solve this, there's a feature available that will organize code according to a custom top namespace and re-write the imports.
Poetry
You can choose a custom namespace to be used in the build process, by using the --with-top-namespace
flag.
This is available for Python 3.9 and above.
The build-project
command, with a custom top namespace:
Hatch, PDM, Rye and uv
A custom top namespace is defined in the project-specific pyproject.toml
:
Result
By using the Poetry build-project flag or the Hatch Build Hook, the built artifact will look something like this:
And the Python modules will have the custom top namespace as a prefix to imports:
How is this done?
The command uses AST (Abstract Syntax Tree) parsing to modify source code.
The Python built-in ast
module is used to parse and un-parse Python code.
Script Entrypoints
If you have a script entrypoint,
remember to manually add the custom namespace in your pyproject.toml
.
Example (Poetry):