add devcontainer

Author: gilesknap

.devcontainer/Dockerfile

@@ -0,0 +1,31 @@
+# ideas from https://www.docker.com/blog/containerized-python-development-part-1/
+
+# This file is for use as a .vscode devcontainer as well as a runtime 
+# container. The devcontainer should be rootful and use podman or docker 
+# with user namespaces.
+
+ARG BASE="mcr.microsoft.com/vscode/devcontainers/python:0-3.10-bullseye"
+FROM ${BASE} as base
+
+# use root to pin where the packages will install
+USER root
+ENV PATH=/root/.local/bin:$PATH
+
+FROM base as developer
+
+WORKDIR /workspace
+COPY . .
+
+# install runtime from DIST if there is one
+RUN mkdir -p /root/.local && \
+    if [ -d dist ] ; then \
+    touch requirements.txt && \
+    pip install --user -r requirements.txt dist/*.whl ; \
+    fi
+
+FROM base as runtime
+
+COPY --from=developer /root/.local /root/.local
+
+ENTRYPOINT ["python3-pip-skeleton"]
+CMD ["--version"]

.devcontainer/devcontainer.json

@@ -0,0 +1,68 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.231.6/containers/python-3
+{
+    "name": "Python 3",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "target": "developer",
+        "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,
+        "python.linting.pylintEnabled": true,
+        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+    },
+    // Add the IDs of extensions you want installed when the container is created.
+    "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "streetsidesoftware.code-spell-checker",
+        "ryanluker.vscode-coverage-gutters",
+        "mhutchie.git-graph",
+        "eamodio.gitlens",
+        "gruntfuggly.todo-tree",
+        "redhat.vscode-yaml",
+        "nsd.vscode-epics",
+        "alefragnani.bookmarks"
+    ],
+    "features": {
+        //"docker-from-docker": "20.10",
+        "git": "os-provided"
+    },
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+    // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+    // "remoteUser": "vscode",
+    // 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 may be useful
+        "source=${localEnv:HOME},target=${localEnv:HOME},type=bind,consistency=cached"
+    ],
+    "workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind",
+    "workspaceFolder": "/workspace",
+    // After the container is created, install the python project in editable form
+    // This installs into the system python of the container
+    "postCreateCommand": "pip install $([ -f requirements_dev.txt ] && echo -r requirements_dev.txt ) -e .[dev]"
+}

.devcontainer/local_build.sh

@@ -0,0 +1,18 @@
+# locally build a runtime container for testing
+
+# first make sure a wheel is built
+(
+    cd ..
+    pip install build
+    rm -r dist
+    python -m build --wheel
+)
+
+# make the container name the same as the root folder name of this clone
+container_name=$(cd ..; basename $(realpath .))
+echo building $container_name ...
+
+# run the build with required build-args for a runtime build
+ln -s ../dist .
+podman build --build-arg BASE=python:3.10-slim --build-arg ENTRYPOINT=$container_name -t $container_name .. --file ./Dockerfile
+unlink dist