Merge pull request #28 from softwareone-platform/MPT-17883-add-uv-commands

MPT-17833: add uv commands to makefile

Author: svazquezco

Dockerfile

@@ -2,26 +2,25 @@ FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS base
 
 WORKDIR /extension
 
-RUN uv venv /opt/venv
-
-ENV VIRTUAL_ENV=/opt/venv
-ENV PATH=/opt/venv/bin:$PATH
+ENV UV_LINK_MODE=copy
+ENV PATH=/extension/.venv/bin:$PATH
 
 FROM base AS build
 
 COPY . .
 
-RUN uv sync --frozen --no-cache --all-groups --active
+RUN uv sync --frozen --no-cache --no-dev
 
 FROM build AS dev
 
+RUN uv sync --frozen --no-cache --dev
 
 CMD ["swoext", "run"]
 
 FROM build AS prod
 
 RUN groupadd -r appuser && useradd -r -g appuser appuser && \
-    chown -R appuser:appuser /extension /opt/venv
+    chown -R appuser:appuser /extension
 
 USER appuser
 

README.md

@@ -14,8 +14,6 @@ Playground Extension with the SoftwareONE Marketplace
 
 - Docker and Docker Compose plugin (`docker compose` CLI)
 - `make`
-- Valid `.env` file
-- Adobe credentials and authorizations JSON files in the project root
 - [CodeRabbit CLI](https://www.coderabbit.ai/cli) (optional. Used for running review check locally)
 
 
@@ -38,45 +36,61 @@ The project uses a modular Makefile structure that organizes commands into logic
 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.
 
-## Running tests
 
-Tests run inside Docker using the dev configuration.
+### Setup
 
-Run the full test suite:
+Follow these steps to set up the development environment:
+
+#### 1. Clone the repository
 
 ```bash
-make test
+git clone <repository-url>
+```
+```bash
+cd swo-extension-playground
 ```
 
-Pass additional arguments to pytest using the `args` variable:
+#### 2. Create environment configuration
+
+Copy the sample environment file and update it with your values:
 
 ```bash
-make test args="-k test_playground -vv"
-make test args="tests/test_steps.py"
+cp .env.sample .env
 ```
 
-## Running the service
+Edit the `.env` file with your actual configuration values. See the [Configuration](#configuration) section for details on available variables.
 
-### 1. Configuration files
+#### 3. Build the Docker images
 
-In the project root, create and configure the following files.
+Build the development environment:
 
-#### Environment files
+```bash
+make build
+```
+
+This will create the Docker images with all required dependencies and the virtualenv.
+
+> **Note on local development without Docker:**
+> Docker is the primary development environment, the default setup and Makefile commands are designed to work only with Docker.
+> `.venv` is used as the default virtualenv, and the project folder is mounted as a volume in docker-compose.
+> If you want to run the project locally (without Docker), use a different virtualenv name to avoid confusion
+> (e.g., `.venv_local`, `env/`, `venv`, `ENV/` - it will be ignored from docker and gitignore)
+> You can also set the `UV_PROJECT_ENVIRONMENT` in your .env file to point `uv` to your local environment.
+
+#### 4. Verify the setup
 
-Start from the sample file:
+Run the test suite to ensure everything is configured correctly:
 
 ```bash
-cp .env.sample .env
+make test
 ```
 
-Update `.env` with your values. This file is used by all Docker Compose configurations and the `make run` target.
+You're now ready to start developing! See [Running the service](#running-the-service) for next steps.
 
-### 2. Running
 
-Run the service against real SoftwareONE Marketplace APIs. It uses `compose.yaml` and reads environment from `.env`.
+## Running the service
 
-Ensure:
-- `.env` is populated with real endpoints and tokens.
+Before running, ensure your `.env` file is populated with real endpoints and tokens.
 
 Start the app:
 

make/common.mk

@@ -7,6 +7,7 @@ bash:  ## Open a bash shell
 
 build:  ## Build images
 	$(DC) build
+	$(RUN) uv sync
 
 check:  ## Check code quality with ruff
 	$(RUN) bash -c "ruff format --check . && ruff check . && flake8 . && uv lock --check"
@@ -27,3 +28,17 @@ shell:  ## Open Django 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