ci: add dev container (#1586)

* add dev container

* configure submodule

* Merge branch 'master' into dev_container_set_up

* pipenv instal --dev

Co-Authored-By: Florian Aucomte <[email protected]>

.devcontainer.json

@@ -0,0 +1,41 @@
+{
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "visualstudioexptteam.vscodeintellicode",
+        "github.vscode-pull-request-github",
+        "redhat.vscode-yaml",
+        "davidanson.vscode-markdownlint",
+        "bierner.markdown-mermaid",
+        "streetsidesoftware.code-spell-checker",
+        "ms-python.python",
+        "ms-python.debugpy",
+        "ms-python.pylint",
+        "ms-python.isort",
+        "ms-python.vscode-pylance",
+        "ms-python.mypy-type-checker",
+        "ms-python.black-formatter",
+        "qwtel.sqlite-viewer",
+        "njpwerner.autodocstring"
+      ]
+    }
+  },
+  "dockerComposeFile": [
+    "../docker-compose.yml"
+  ],
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/pipenv:2": {
+      "version": "2023.11.15"
+    },
+    "ghcr.io/devcontainers/features/python:1": {
+      "installTools": false,
+      "version": "3.8"
+    }
+  },
+  "name": "rapid-router",
+  "postCreateCommand": "pipenv install --dev",
+  "remoteUser": "root",
+  "service": "base-service",
+  "shutdownAction": "none",
+  "workspaceFolder": "/workspace/rapid-router"
+}

.vscode/codeforlife.code-snippets

@@ -0,0 +1,35 @@
+{
+  "python.module.docstring": {
+    "body": [
+      "\"\"\"",
+      "\u00a9 Ocado Group",
+      "Created on $CURRENT_DATE/$CURRENT_MONTH/$CURRENT_YEAR at $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND($CURRENT_TIMEZONE_OFFSET).",
+      "",
+      "${1:__description__}",
+      "\"\"\""
+    ],
+    "prefix": [
+      "\"\"\"",
+      "'''"
+    ],
+    "scope": "python"
+  },
+  "python.mypy.ignore": {
+    "body": [
+      "# type: ignore[${1:__code_name__}]"
+    ],
+    "prefix": [
+      "# type"
+    ],
+    "scope": "python"
+  },
+  "python.pylint.disable-next": {
+    "body": [
+      "# pylint: disable-next=${1:__code_name__}"
+    ],
+    "prefix": [
+      "# pylint"
+    ],
+    "scope": "python"
+  }
+}

.vscode/launch.json

@@ -1,29 +1,34 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
   "configurations": [
     {
-      "name": "Django Server",
-      "type": "python",
-      "request": "launch",
-      "django": true,
-      "justMyCode": false,
-      "program": "${workspaceFolder}/example_project/manage.py",
       "args": [
         "runserver",
         "localhost:8000"
-      ]
+      ],
+      "django": true,
+      "justMyCode": false,
+      "name": "Django Server",
+      "program": "${workspaceFolder}/example_project/manage.py",
+      "request": "launch",
+      "type": "debugpy"
     },
     {
-      "name": "Pytest",
-      "type": "python",
-      "request": "test",
+      "console": "integratedTerminal",
       "justMyCode": false,
+      "name": "Python: Current File",
+      "program": "${file}",
+      "request": "launch",
+      "type": "debugpy"
+    },
+    {
+      "justMyCode": false,
+      "name": "Pytest",
       "presentation": {
         "hidden": true
-      }
+      },
+      "request": "test",
+      "type": "debugpy"
     }
-  ]
+  ],
+  "version": "0.2.0"
 }

.vscode/settings.json

@@ -1,4 +1,71 @@
 {
-  "python.testing.unittestEnabled": false,
-  "python.testing.pytestEnabled": true
+  "[md]": {
+    "editor.tabSize": 4
+  },
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.tabSize": 4
+  },
+  "black-formatter.args": [
+    "--config",
+    "pyproject.toml"
+  ],
+  "black-formatter.path": [
+    ".venv/bin/python",
+    "-m",
+    "black"
+  ],
+  "cSpell.words": [
+    "codeforlife",
+    "klass",
+    "ocado",
+    "kurono",
+    "pipenv"
+  ],
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit"
+  },
+  "editor.formatOnSave": true,
+  "editor.rulers": [
+    80
+  ],
+  "editor.tabSize": 2,
+  "files.exclude": {
+    "**/.hypothesis": true,
+    "**/.mypy_cache": true,
+    "**/.pytest_cache": true,
+    "**/__pycache__": true
+  },
+  "isort.args": [
+    "--settings-file=pyproject.toml"
+  ],
+  "isort.path": [
+    ".venv/bin/python",
+    "-m",
+    "isort"
+  ],
+  "mypy-type-checker.args": [
+    "--config-file=pyproject.toml"
+  ],
+  "mypy-type-checker.path": [
+    ".venv/bin/python",
+    "-m",
+    "mypy"
+  ],
+  "pylint.args": [
+    "--rcfile=pyproject.toml"
+  ],
+  "pylint.path": [
+    ".venv/bin/python",
+    "-m",
+    "pylint"
+  ],
+  "python.defaultInterpreterPath": ".venv/bin/python",
+  "python.testing.pytestArgs": [
+    "-n=auto",
+    "-c=pyproject.toml",
+    "."
+  ],
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false
 }

codeforlife.code-workspace

@@ -0,0 +1,14 @@
+{
+  "folders": [
+    {
+      "name": "rapid-router",
+      "path": "."
+    }
+  ],
+  "settings": {
+    "autoDocstring.customTemplatePath": ".vscode/extensions/autoDocstring/docstring.mustache",
+    "workbench.colorCustomizations": {
+      "editorRuler.foreground": "#008000"
+    }
+  }
+}