py-monorepo-multimodule-template

Table of Contents

• Overview
• Prerequisites
• Run
• Directory structure

Overview

• This project is a Python-based, monorepo template demo.

Prerequisites

• python 3.13+

• uv 0.5+

• just 1.40+

• A system that can run the docker command

  • If you are on OSX, you must install Docker Desktop.

  • For Windows, it is recommended to install directly in the WSL2 environment. In this case, it is convenient to use an IDE that supports remote development. ** [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview)

    • [PyCharm Remote Development](https://www.jetbrains.com/help/pycharm/remote-development-overview.html)

Run

Install just command, and check the recipe list.

/ $ just
Available recipes:
    [help]
    help                    # Default execution options. Show a list of available commands.

    [project]
    common_libs *args       # View a list of common library management commands.
    hello_multimodule *args # View a list of commands related to the "hello_multimodule" application.
    quotes_of_day *args     # View a list of commands related to the "quotes_of_day" application.

Directory structure

├── apps/                     # Collection of application source files
│   ├── common_libs/          # Collection of common libraries used by all applications in Monorepo
│   │   └── ...
│   ├── hello_multimodule/    # Python multimodule app demo
│   │   ├── api_server/
│   │   │   └── ...
│   │   ├── core/
│   │   │   └── ...
│   │   ├── infrastructure/
│   │   │   └── ...
│   │   └── util/
│   │       └── ...
│   └── quotes_of_day         # Another app demo completely unrelated to hello_multimodule
│       └── ...
├── docs/                     # Directory for organizing various documentation files
│   └── ...
└── README.adoc