Merge branch 'febner/unify-dockerfile' into 'main'

unify Dockerfile, .dockerignore all, ci default tags

See merge request common/python-package-template!5

Author: Franz Ebner

{{ cookiecutter.__package_name_kebab_case }}/.devcontainer/devcontainer.json

@@ -6,7 +6,11 @@
 		// Sets the run context to one level up instead of the .devcontainer folder.
 		"context": "..",
 		// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
-		"dockerfile": "../Dockerfile-cuda"
+		"dockerfile": "../Dockerfile",
+		"args": {
+			"IMAGE_NAME": "nvidia/cuda:12.3.1-runtime-ubuntu22.04"
+		},
+		"target": "dev"
 	},
 	"features": {
 		"ghcr.io/devcontainers/features/git-lfs:1": {
@@ -16,7 +20,7 @@
 	},
 	"runArgs": [
 		"--gpus=all"
-	],
+	]
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},

{{ cookiecutter.__package_name_kebab_case }}/.dockerignore

@@ -1 +1,11 @@
-.venv
+# Ignore everything
+*
+
+# but
+!/pyproject.toml
+!/poetry.lock
+!/{{ cookiecutter.__package_name_snake_case }}/**/*.py
+
+# but but
+# Ignore the unignored
+# /{{ cookiecutter.__package_name_snake_case }}/super/specific.py

…ckage_name_kebab_case }}/Dockerfile-cuda ….__package_name_kebab_case }}/Dockerfile{{ cookiecutter.__package_name_kebab_case }}/Dockerfile-cuda renamed to {{ cookiecutter.__package_name_kebab_case }}/Dockerfile {{ cookiecutter.__package_name_kebab_case }}/Dockerfile-cuda renamed to {{ cookiecutter.__package_name_kebab_case }}/Dockerfile

@@ -1,25 +1,21 @@
-# This dockerfile serves as a base for all testing images.
-# It contains the minimal dependencies and is therefore smaller.
-FROM nvidia/cuda:12.3.1-runtime-ubuntu22.04
+#TODO: might be cool to have a fixed image, to assure reproducibility
+ARG FROM_IMAGE=debian:stable-slim
+FROM FROM_IMAGE AS build
 
 ARG PYTHON_VERSION={{cookiecutter.python_version}}
 ARG POETRY_VERSION=1.8.0
-ENV DEBIAN_FRONTEND noninteractive
+ENV DEBIAN_FRONTEND=noninteractive
 
 LABEL maintainer="{{cookiecutter.author_name}} <{{cookiecutter.author_email}}>"
 
-RUN apt-get update --allow-insecure-repositories && apt-get install -yq \ 
+RUN apt-get update && apt-get install -yq \
     build-essential \
-    # provides nohup command
-    coreutils \
-    # editor
-    vim \
     libssl-dev \
     zlib1g-dev \
     libbz2-dev \
     libreadline-dev \
     libsqlite3-dev \
-    curl \ 
+    curl \
     libncursesw5-dev \
     xz-utils \
     tk-dev \
@@ -31,14 +27,16 @@ RUN apt-get update --allow-insecure-repositories && apt-get install -yq \
     python3-distutils \
     && rm -rf /var/lib/apt/lists/*
 
-ENV PYENV_ROOT $HOME/.pyenv
-ENV PATH $PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH
+ENV PYENV_ROOT=$HOME/.pyenv
+ENV PATH=$PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH
 
 # Install pyenv
 RUN set -ex \
     && curl https://pyenv.run | bash \
-    && pyenv update \
-    && pyenv install -s ${PYTHON_VERSION} \
+    && pyenv update
+
+# Install python and set interpreter
+RUN pyenv install -s ${PYTHON_VERSION} \
     && pyenv global ${PYTHON_VERSION} \
     && pyenv rehash
 
@@ -50,11 +48,11 @@ RUN curl -sSL https://install.python-poetry.org | python -
 ENV PATH="${PATH}:${POETRY_HOME}/bin"
 
 # Setup directory structure
-RUN mkdir /repo
-WORKDIR /repo
+RUN mkdir /workspace
+WORKDIR /workspace
 
-# set pythonpath for nvidia image
-ENV PYTHONPATH "${PYTHONPATH}:/repo"
+# set python path to default
+ENV PYTHONPATH="${PYTHONPATH}:/workspace"
 
 # Install dependencies (package itself is not installed)
 COPY pyproject.toml poetry.lock ./
@@ -66,6 +64,22 @@ RUN pyenv rehash
 # Copy the rest of the repository
 ADD . .
 
-# special entry point which allows you to start the container manually, will keep the container alive
-# ENTRYPOINT ["tail", "-f", "/dev/null"]
 
+# TODO: build from FROM_IMAGE (or a plain python img), and just copy from build (without pyenv, poetry)
+FROM build AS runtime
+
+
+FROM base AS dev
+
+RUN eval "$(pyenv init -)" \
+    # activate pyenv on shell start
+    && pyenv init - > ~/.bashrc
+
+RUN poetry install --all-extras --no-root
+
+RUN apt-get update --allow-insecure-repositories && apt-get install -yq \ 
+    # provides nohup command
+    coreutils \
+    # editor
+    vim \
+    && rm -rf /var/lib/apt/lists/*