build: devcontainer TDE-598

.devcontainer/Dockerfile

@@ -0,0 +1,9 @@
+FROM osgeo/gdal:ubuntu-small-3.6.1
+
+RUN apt update && apt install -y python3-pip python3-distutils git
+RUN curl -sSL https://install.python-poetry.org | python3 -
+
+# Allowing access to osgeo/gdal python library within the venv environment created with Poetry
+ENV PYTHONPATH="/lib/python3/dist-packages:/workspaces/topo-imagery:$PYTHONPATH"
+
+ENV PATH=/root/.local/bin:$PATH

.devcontainer/README.md

@@ -0,0 +1,25 @@
+# topo-imagery devcontainer
+
+The purpose of this devcontainer is to avoid any trouble to the developers managing a Python environment with GDAL and other dependencies.
+
+> **_NOTE:_** It has been setup to be used with VSCode under a linux environment. Some functionalities might not work with a different configuration.
+
+## `Dockerfile`
+
+This Docker container describes the OS configuration for the development environment. It is intended to be based on the same Docker image than our production container.
+
+## `devcontainer.json`
+
+It allows us to use common settings for the development environment.
+
+### `post_create.sh`
+
+This script is run after the container is created.
+
+### `post_start.sh`
+
+This script is run everytime the container is started.
+
+## Usage
+
+Once opened the local cloned repository in VSCode, click on the bottom left corner green button `><` `Open a Remote Window` and select the `Reopen in Container` option. Wait for the container to be build. Open a new terminal from VSCode. It should source the Python `venv`.

.devcontainer/devcontainer.json

@@ -0,0 +1,50 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
+{
+  "name": "topo-imagery-dev",
+  "context": "..",
+  "dockerFile": "Dockerfile",
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "/bin/bash"
+          }
+        },
+        "editor.codeActionsOnSave": {
+          "source.organizeImports": true
+        },
+        "python.defaultInterpreterPath": "${containerWorkspaceFolder}/.venv/bin/python3.10",
+        "python.formatting.blackPath": "${containerWorkspaceFolder}/.venv/bin/black",
+        "python.linting.mypyPath": "${containerWorkspaceFolder}/.venv/bin/mypy",
+        "python.linting.pylintPath": "${containerWorkspaceFolder}/.venv/bin/pylint",
+        "python.formatting.provider": "black",
+        "python.testing.pytestEnabled": true,
+        "python.linting.enabled": true,
+        "python.linting.pylintEnabled": true,
+        "editor.formatOnSave": true,
+        "autoDocstring.docstringFormat": "google-notypes"
+      },
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "esbenp.prettier-vscode",
+        "njpwerner.autodocstring"
+      ]
+    }
+  },
+  "postCreateCommand": "bash ./.devcontainer/post_create.sh",
+  "postStartCommand": "bash ./.devcontainer/post_start.sh ${containerWorkspaceFolder}",
+  "mounts": [
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/root/.aws,type=bind",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.bashrc,target=/root/.bashrc,type=bind,consistency=cached"
+    //"source=${localEnv:HOME}${localEnv:USERPROFILE}/tmp,target=/tmp,type=bind"
+  ],
+  // https://containers.dev/features
+  // NOTE: installing Git in that way took more time than within the Dockerfile
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+  },
+  "waitFor": "postCreateCommand"
+}

.devcontainer/post_create.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Change Poetry settings to better deal with working in a container
+poetry config cache-dir $(pwd)/.cache
+poetry config virtualenvs.in-project true

.devcontainer/post_start.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+# Install all dependencies with poetry
+poetry install --no-interaction
+git config --global --add safe.directory $1
+poetry run pre-commit install

.gitignore

@@ -1,3 +1,4 @@
+/.cache
 /.coverage
 /html/
 /htmlcov/

README.md

@@ -36,6 +36,10 @@ Example:
 docker run -v ${HOME}/.aws/credentials:/root/.aws/credentials:ro -e AWS_PROFILE 'image-id'  python create_polygons.py --uri 's3://path-to-the-tiff/image.tif' --destination 'destination-bucket'
 ```
 
+#### Development
+
+This repo has a `devcontainer` which can be used within VSCode as a development environment with all of the required dependencies included. See the [.devcontainer/README.md](/.devcontainer/README.md) for more information.
+
 ## Container package
 
 Publishing a container to the GitHub Package registry (`ghcr`) is handled automatically by GitHub Actions in this repo.