DevContainer

Author: lambda-science

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.13-slim-bullseye
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_NO_CACHE=1
+
+RUN apt update && \
+    apt install -y --no-install-recommends \
+    build-essential \
+    cmake \
+    curl \
+    gcc \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /workspaces/modern-python-boilerplate

.devcontainer/devcontainer.json

@@ -0,0 +1,14 @@
+{
+  "name": "Modern Python Boilerplate DevContainer",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": "."
+  },
+  "forwardPorts": [8000],
+  "postCreateCommand": "uv sync && make commit",
+  "remoteUser": "root",
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {}
+  },
+  "workspaceFolder": "/workspaces/modern-python-boilerplate"
+}

Makefile

@@ -17,10 +17,10 @@ help:
 	@echo "  make allci              Run all CI steps (check, format, type, test coverage)"
 
 dev:
-	modern_python_boilerplate
+	uv run modern_python_boilerplate
 
 prod:
-	modern_python_boilerplate
+	uv run modern_python_boilerplate
 
 test:
 	uv run pytest tests/
@@ -47,7 +47,7 @@ publish:
 	uv publish
 
 commit:
-	pre-commit
+	uv run pre-commit
 
 dockerbuild:
 	docker build -t modern-python-boilerplate:latest .

README.md

@@ -19,12 +19,12 @@ A global `Makefile` to run all the commands. You can run `make help` to see all
 - **Documentation**
   - Mkdocs for documentation building with Markdown `make doc`
   - Automatic build of the API Reference page
-  - Pre-configured GitHub Action / Gitlab CI for publishing the documentation on Github pages / Gitlab pages
+  - Pre-configured GitHub Action / Gitlab CI for publishing the documentation on Github pages / Gitlab page
 - **Running, Publishing and Deploying**
   - Build the pacakge with UV `make build`
   - Publish to PyPi with Twine `make publish`
   - Dockerfile to run in a container `make dockerbuild` and `make dockerrun`
-  - DevContainer pre-configured. `.devcontainer/devcontainer.json`
+  - DevContainer pre-configured. `.devcontainer/devcontainer.json`, working with PyCharm
 
 # How to use
 1. Delete this README.md to replace by you package one.