Setup

1. Create a repository

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

git init

poetry init

From the Poetry docs:

This command will help you create a pyproject.toml file interactively by prompting you to provide basic information about your package. It will interactively ask you to fill in the fields, while using some smart defaults.

Next step: create a Polylith Workspace.

2. Create a workspace

Ceate a workspace, with a basic Polylith folder structure.

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

--name (required) the workspace name, that will be used as the single top namespace for all bricks. Choose the name wisely. Have a look in PEP-423 for naming guidelines.

--theme the structure of the workspace, loose is the recommended structure for Python.

3. Create a virtual environment

Create a virtual environment for the workspace, by running:

poetry install

Besides creating a virtual environment, this command will make the virtual environment aware of the bases and components folders.

You will find more documentation about the available commands in the commands section.