poetry-multiproject-plugin 1.1.2

A Poetry plugin that makes it possible to use relative package includes.

Poetry Multiproject Plugin

This is a Python Poetry plugin, adding the build-project and check-project commands.

The build-project command will make it possible to use relative package includes. This feature is very useful for monorepos and when sharing code between projects.

The check-project command is useful to check that dependencies are added properly in a project. It uses the MyPy tool under the hood, and will output any errors from the static type checker.

Usage

Navigate to the project folder (where the pyproject.toml file is).

Build a project:

poetry build-project

Check the code used in a project:

poetry check-project

Check the code, with a custom MyPy configuration to override the defaults:

poetry check-project --config-file <PATH-TO-MYPY.INI-CONFIG-FILE>

Installation

This plugin can be installed according to the official Poetry docs.

poetry self add poetry-multiproject-plugin

What does it do?

the poetry build-project command will:

1. copy the actual project into a temporary folder.
2. collect relative includes - such as include = "foo/bar", from = "../../shared" - and copy them into the temprary folder.
3. generate a new pyproject.toml.
4. run the poetry build command in the temporary folder.
5. copy the built dist folder (containing the wheel and sdist) into the actual project folder.
6. remove the temporary folder.

the poetry check-project command will:

1. copy the actual project into a temporary folder.
2. collect relative includes - such as include = "foo/bar", from = "../../shared" - and copy them into the temprary folder.
3. generate a new pyproject.toml.
4. run poetry install in the temporary folder.
5. run poetry run mypy in the temporary folder.
6. remove the temporary folder.

The default setting for the underlying MyPy configuration is:

--explicit-package-bases --namespace-packages --no-error-summary --no-color-output

How is it different from the "poetry build" command?

Poetry does not allow package includes outside of the project root.

# Note the structure of the shared folder: namespace/package

packages = [
    { include = "my_namespace/my_package", from = "../../shared" }
    { include = "my_namespace/my_other_package", from = "../../shared" }
]

This plugin will allow relative package includes. You will now be able to share code between projects.

An suggested Monorepo structure, with the shared code extracted into a separate folder structure:

projects/
  my_app/
    pyproject.toml (including a shared package)

  my_service/
    pyproject.toml (including other shared packages)

shared/
  my_namespace/
    my_package/
      __init__.py
      code.py

    my_other_package/
      __init__.py
      code.py