MPT-17674: propagate-changes-from-template (#39)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
Closes [MPT-17674](https://softwareone.atlassian.net/browse/MPT-17674)

- .editorconfig: enforce tab indentation for Makefile and *.mk files
- .pre-commit-config.yaml: normalize package names to lowercase and
reorder flake8-related entries
- Replace legacy Makefile with a modular Makefile system:
- New top-level Makefile dynamically includes make/*.mk fragments,
auto-generates .PHONY targets, adds a require helper macro, and sets
default goal to help
- Added make/common.mk: Docker Compose-based development workflow and
targets (build, test, check, check-all, format, run, bash, shell) and uv
dependency management (uv-add, uv-add-dev, uv-upgrade)
  - Added make/external_tools.mk: review target (CodeRabbit)
  - Added make/repo.mk: placeholder for repo-specific targets
- Removed old legacy makefile (full deletion) and migrated functionality
into the new modular layout
- Dockerfile refactor:
- Replace VIRTUAL_ENV usage with UV_PROJECT_ENVIRONMENT and preserve
PATH
- Adjust build stage (COPY . . and uv sync --no-dev), add dev stage (uv
sync --dev), and add prod stage that removes tests, creates appuser,
sets UV_CACHE_DIR and switches to non-root user
- README.md: reorganized into a setup-first guide with explicit Makefile
structure, setup workflow, developer utilities, and configuration
section (env vars)
- docs/PROJECT_DESCRIPTION.md: add pre-commit snippets showing how to
check migrations
- pyproject.toml: minor Ruff config cleanup (remove
docstring-code-format setting)
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

[MPT-17674]:
https://softwareone.atlassian.net/browse/MPT-17674?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: d3rky

.editorconfig

@@ -12,3 +12,6 @@ indent_size = 2
 
 [*.py]
 indent_size = 4
+
+[{Makefile,*.mk}]
+indent_style = tab

.gitignore

@@ -167,7 +167,9 @@ cython_debug/
 .ruff_cache
 .idea
 
-# Specific project gitignore
+# Makefile
+make/local.mk
+
+# mpt-tool
 migrations/
 .migrations-state.json
-settings.py

.pre-commit-config.yaml

@@ -28,8 +28,8 @@ repos:
       - id: flake8
         additional_dependencies:
           [
-            Flake8-pyproject==1.2.*,
-            Flake8-AAA==0.17.*,
+            flake8-aaa==0.17.*,
+            flake8-pyproject==1.2.*,
             wemake-python-styleguide==1.5.*,
           ]
 

Dockerfile

@@ -2,17 +2,33 @@ FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS base
 
 WORKDIR /mpt_tool
 
-COPY . ./
-
 RUN uv venv /opt/venv
 
-ENV VIRTUAL_ENV=/opt/venv
+ENV UV_PROJECT_ENVIRONMENT=/opt/venv
 ENV PATH=/opt/venv/bin:$PATH
 
 FROM base AS build
 
-RUN uv sync --frozen --no-cache --all-groups --active
+COPY . .
+
+RUN uv sync --frozen --no-cache --no-dev
 
 FROM build AS dev
 
+RUN uv sync --frozen --no-cache --dev
+
+CMD ["bash"]
+
+FROM build AS prod
+
+RUN rm -rf tests/
+
+RUN groupadd -r appuser && useradd -r -g appuser -m -d /home/appuser appuser && \
+    mkdir -p /home/appuser/.cache/uv && \
+    chown -R appuser:appuser /mpt_tool /opt/venv /home/appuser
+
+ENV UV_CACHE_DIR=/home/appuser/.cache/uv
+
+USER appuser
+
 CMD ["bash"]

Makefile

@@ -0,0 +1,11 @@
+MK_FILES := $(sort $(wildcard make/*.mk))
+-include $(MK_FILES)
+
+.DEFAULT_GOAL := help
+.PHONY: $(shell awk -F: '/^[a-zA-Z0-9_-]+:([^=]|$$)/ {print $$1}' $(MAKEFILE_LIST))
+
+require = $(if $(value $(1)),,$(error Missing required variable: $(1). Example: make $(MAKECMDGOALS) $(1)=<value>))
+
+help:  ## Show available commands
+	@echo "Available commands:"
+	@awk 'BEGIN {FS = ":.*##"} /^[a-zA-Z0-9_-]+:.*##/ {printf "  make %-22s %s\n", $$1, $$2}' $(MAKEFILE_LIST)

README.md

@@ -19,58 +19,80 @@ to manage both schema and data migrations across multiple backends, ensuring con
 - Docker and Docker Compose plugin (`docker compose` CLI)
 - `make`
 - [CodeRabbit CLI](https://www.coderabbit.ai/cli) (optional. Used for running review check locally)
-- Copy .env.sample to .env
+
 
 ### Make targets overview
 
-Common development workflows are wrapped in the `makefile`:
+Common development workflows are wrapped in the `Makefile`. Run `make help` to see the list of available commands.
+
+### How the Makefile works
+
+The project uses a modular Makefile structure that organizes commands into logical groups:
+
+- **Main Makefile** (`Makefile`): Entry point that automatically includes all `.mk` files from the `make/` directory
+- **Modular includes** (`make/*.mk`): Commands are organized by category:
+  - `common.mk` - Core development commands (build, test, format, etc.)
+  - `repo.mk` - Repository management and dependency commands
+  - `migrations.mk` - Database migration commands (Only available in extension repositories)
+  - `external_tools.mk` - Integration with external tools
+
+
+You can extend the Makefile with your own custom commands creating a `local.mk` file inside make folder. This file is
+automatically ignored by git, so your personal commands won't affect other developers or appear in version control.
+
 
-- `make help` – list available commands
-- `make bash` – start the app container and open a bash shell
-- `make build` – build the application image for development
-- `make check` – run code quality checks (ruff, flake8, lockfile check)
-- `make check-all` – run checks and tests
-- `make format` – apply formatting and import fixes
-- `make down` – stop and remove containers
-- `make review` –  check the code in the cli by running CodeRabbit
-- `make run` – run the CLI tool
-- `make test` – run the test suite with pytest
+### Setup
 
-## Running CLI commands
+Follow these steps to set up the development environment:
+
+#### 1. Clone the repository
 
-Run the CLI tool:
 ```bash
-make run
+git clone <repository-url>
+```
+```bash
+cd mpt-tool
+```
+
+#### 2. Create environment configuration
+
+Copy the sample environment file and update it with your values:
+
+```bash
+cp .env.sample .env
 ```
 
-## Running tests
+Edit the `.env` file with your actual configuration values. See the [Configuration](#configuration) section for details on available variables.
 
-Tests run inside Docker using the dev configuration.
+#### 3. Build the Docker images
 
-Run the full test suite:
+Build the development environment:
 
 ```bash
-make test
+make build
 ```
 
-Pass additional arguments to pytest using the `args` variable:
+This will create the Docker images with all required dependencies and the virtualenv.
+
+#### 4. Verify the setup
+
+Run the test suite to ensure everything is configured correctly:
 
 ```bash
-make test args="-k test_cli -vv"
-make test args="tests/test_cli.py"
+make test
 ```
 
-## Pre-commit
+You're now ready to start developing! See [Running the cli](#running-the-cli) for next steps.
+
 
-Checking migrations with pre-commit:
+## Running the cli
 
-Add this to your .pre-commit-config.yaml
+Before running, ensure your `.env` file is populated.
 
-```yaml
--   repo: https://github.com/softwareone-platform/mpt-tool
-    rev: ''  # Use the sha / tag you want to point at
-    hooks:
-    -   id: check-migrations
+Start the cli:
+
+```bash
+make run
 ```
 
 ## Developer utilities
@@ -84,3 +106,18 @@ make check-all # run checks and tests
 make format    # auto-format code and imports
 make review    # check the code in the cli by running CodeRabbit
 ```
+
+## Configuration
+
+The following environment variables are typically set in `.env`. Docker Compose reads them when using the Make targets described above.
+
+### Application
+
+| Environment Variable                   | Default                 | Example                                   | Description                                                                               |
+|----------------------------------------|-------------------------|-------------------------------------------|-------------------------------------------------------------------------------------------|
+| `MPT_API_BASE_URL`                     | `http://localhost:8000` | `https://portal.softwareone.com/mpt`      | SoftwareONE Marketplace API URL                                                           |
+| `MPT_API_TOKEN`                        | -                       | eyJhbGciOiJSUzI1N...                      | SoftwareONE Marketplace API Token                                                         |
+| `MPT_TOOL_STORAGE_TYPE`                | `local`                 | `airtable`                                | Storage type for MPT tools (local or airtable)                                            |
+| `MPT_TOOL_STORAGE_AIRTABLE_API_KEY`    | -                       | patXXXXXXXXXXXXXX                         | Airtable API key for MPT tool storage (required when storage type is airtable)            |
+| `MPT_TOOL_STORAGE_AIRTABLE_BASE_ID`    | -                       | appXXXXXXXXXXXXXX                         | Airtable base ID for MPT tool storage (required when storage type is airtable)            |
+| `MPT_TOOL_STORAGE_AIRTABLE_TABLE_NAME` | -                       | MigrationTracking                         | Airtable table name for MPT tool storage (required when storage type is airtable)         |

docs/PROJECT_DESCRIPTION.md

@@ -340,6 +340,18 @@ Run `mpt-service-cli --help` to see all available commands and params:
   - Create a new migration with the updated logic
 - Never modify an already-applied migration in production
 
+## Pre-commit
+
+Checking migrations with pre-commit:
+
+Add this to your .pre-commit-config.yaml
+
+```yaml
+-   repo: https://github.com/softwareone-platform/mpt-tool
+    rev: ''  # Use the sha / tag you want to point at
+    hooks:
+      - id: check-migrations
+```
 
 ## Development
 

make/common.mk

@@ -0,0 +1,43 @@
+DC = docker compose -f compose.yaml
+RUN = $(DC) run --rm app
+RUN_IT = $(DC) run --rm -it app
+
+bash:  ## Open a bash shell
+	$(RUN_IT) bash
+
+build:  ## Build images
+	$(DC) build
+
+check:  ## Check code quality with ruff
+	$(RUN) bash -c "ruff format --check . && ruff check . && flake8 . && uv lock --check"
+
+check-all:  check test ## Run checks and tests
+
+down:  ## Stop and remove containers
+	$(DC) down
+
+format:  ## Format code
+	$(RUN) bash -c "ruff check --select I --fix . && ruff format ."
+
+run:  ## Run service
+	$(DC) up
+
+shell:  ## Open Django shell
+	$(RUN_IT) bash -c "swoext shell"
+
+test:  ## Run test
+	$(RUN) pytest $(if $(args),$(args),.)
+
+uv-add: ## Add a production dependency (pkg=<package_name>)
+	$(call require,pkg)
+	$(RUN) bash -c "uv add $(pkg)"
+	$(MAKE) build
+
+uv-add-dev: ## Add a dev dependency (pkg=<package_name>)
+	$(call require,pkg)
+	$(RUN) bash -c "uv add --dev $(pkg)"
+	$(MAKE) build
+
+uv-upgrade: ## Upgrade all packages or a specific package (use pkg="package_name" to target one)
+	$(RUN) bash -c "uv lock $(if $(pkg),--upgrade-package $(pkg),--upgrade) && uv sync"
+	$(MAKE) build

make/external_tools.mk

@@ -0,0 +1,2 @@
+review:  ## Run CodeRabbit code review in interactive mode. Pass args=<options> to override or include more options
+	coderabbit review $(args)

make/repo.mk

@@ -0,0 +1 @@
+## Add repo-specific targets here. Do not modify the shared *.mk files.