refactor container build

Author: gilesknap

.containerignore

@@ -0,0 +1,6 @@
+Dockerfile
+build/
+dist/
+.mypy_cache
+.tox
+.venv*

.devcontainer.json

@@ -0,0 +1,41 @@
+// For format details, see https://aka.ms/devcontainer.json
+{
+    "name": "Python 3 Developer Container",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "target": "build",
+        "context": ".",
+        "args": {}
+    },
+    "remoteEnv": {
+        "DISPLAY": "${localEnv:DISPLAY}"
+    },
+    // Set *default* container specific settings.json values on container create.
+    "settings": {
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.linting.enabled": true
+    },
+    // Add the IDs of extensions you want installed when the container is created.
+    "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+    ],
+    // Make sure the files we are mapping into the container exist on the host
+    "initializeCommand": "bash -c 'for i in $HOME/.inputrc $HOME/.bashrc_dev; do [ -f $i ] || touch $i; done'",
+    "runArgs": [
+        "--privileged",
+        "--net=host",
+        "-v=${localEnv:HOME}/.ssh:/root/.ssh",
+        "-v=${localEnv:HOME}/.bashrc_dev:/root/.bashrc",
+        "-v=${localEnv:HOME}/.inputrc:/root/.inputrc"
+    ],
+    "mounts": [
+        // map in home directory - not strictly necessary but useful
+        "source=${localEnv:HOME},target=${localEnv:HOME},type=bind,consistency=cached"
+    ],
+    // make the workspace folder the same inside and outside of the container
+    "workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind",
+    "workspaceFolder": "${localWorkspaceFolder}",
+    // After the container is created, install the python project in editable form
+    "postCreateCommand": "pip install $([ -f requirements_dev.txt ] && echo -r requirements_dev.txt ) -e .[dev]"
+}

.devcontainer/Dockerfile

@@ -215,7 +215,8 @@ jobs:
           outputs: type=docker,dest=/tmp/image.tar
 
       - name: show tags
-        run: echo This is the tags generated by Docker meta
+        run: |
+          echo This is the tags generated by Docker meta
           echo ${{ steps.meta.outputs.tags }}
 
       - name: Upload container image

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+# This file is for use as a devcontainer and a runtime container
+# 
+# The devcontainer should use the build target and run as root and use podman 
+# or docker with user namespaces.
+#
+
+FROM python:3.10 as build
+
+RUN apt-get update && apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    busybox \
+    git \
+    net-tools \
+    vim \
+    && rm -rf /var/lib/apt/lists/* \
+    && busybox --install
+
+RUN python3 -m venv /virtualenv
+ENV PATH=/virtualenv/bin:$PATH
+
+COPY . /project
+
+# verify that the wheel installs and runs with --version
+# replace python3-pip-skeleton if the cli command is different from repo name
+RUN cd /project && \
+    pip install --upgrade pip build && \
+    python -m build --sdist --wheel && \
+    pip install dist/*.whl && \
+    python3-pip-skeleton --version
+
+FROM python:3.10-slim as runtime
+
+COPY --from=build /virtualenv/ /virtualenv/
+ENV PATH=/virtualenv/bin:$PATH
+
+ENTRYPOINT ["python3-pip-skeleton"]
+CMD ["--version"]