poetry-polylith-plugin

Poetry Polylith Plugin

This is a Python Poetry plugin, adding CLI support for the Polylith Architecture.

Documentation

Have a look at the documentation. You will find installation, setup, usage guides and more.

Quick start

With the Poetry version 1.2 or later installed, you can add plugins.

Make sure that you have Poetry 1.2 or later installed.

Add the Multiproject plugin, that will enable the very important workspace support (i.e. relative package includes) to Poetry.

poetry self add poetry-multiproject-plugin

Add the Polylith plugin:

poetry self add poetry-polylith-plugin

Create a directory for your code, initialize it with git and create a basic Poetry setup:

git init

poetry init

Next: create a Polylith workspace, with a basic Polylith folder structure.

poetry poly create workspace --name my_namespace --theme loose

Time to start coding. Add components, bases and projects:

poetry poly create component --name my_component

poetry poly create base --name my_example_endpoint

poetry poly create project --name my_example_project

For details, have a look at the documentation. There, you will find guides for setup, migration, packaging, available commands, code examples and more.