mount py package

.devcontainer.json

@@ -0,0 +1,50 @@
+{
+  "name": "sso",
+  "dockerComposeFile": [
+    "../docker-compose.yml"
+  ],
+  "service": "base-service",
+  "shutdownAction": "none",
+  "workspaceFolder": "/workspace/codeforlife-sso",
+  "mounts": [
+    "source=./codeforlife-package-python,target=/workspace/codeforlife-package-python,type=bind,consistency=cached"
+  ],
+  "remoteUser": "root",
+  "features": {
+    "ghcr.io/devcontainers/features/python:1": {
+      "version": "3.8",
+      "installTools": false
+    },
+    "ghcr.io/devcontainers-contrib/features/pipenv:2": {
+      "version": "2023.11.15"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      //TODO: Specify preferred settings and extensions once defined
+      "settings": {
+        "python.defaultInterpreterPath": "backend/.venv/bin/python"
+      },
+      "extensions": [
+        "github.vscode-pull-request-github",
+        "redhat.vscode-yaml",
+        "davidanson.vscode-markdownlint",
+        "bierner.markdown-mermaid",
+        "ms-python.python",
+        "ms-python.pylint",
+        "ms-python.isort",
+        "ms-python.vscode-pylance",
+        "ms-python.mypy-type-checker",
+        "ms-python.black-formatter",
+        "streetsidesoftware.code-spell-checker",
+        "tamasfe.even-better-toml",
+        "kevinrose.vsc-python-indent",
+        "batisteo.vscode-django",
+        "njpwerner.autodocstring",
+        "visualstudioexptteam.vscodeintellicode",
+        "wholroyd.jinja",
+        "qwtel.sqlite-viewer"
+      ]
+    }
+  }
+}

backend/Pipfile

@@ -3,23 +3,33 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 name = "pypi"
 
+## ℹ️ HOW-TO: Make the python-package editable.
+#
+# 1. Comment out the git-codeforlife package under [packages].
+# 2. Comment out the git-codeforlife package under [dev-packages].
+# 3. Uncomment the editable-codeforlife package under [dev-packages].
+# 4. Run `pipenv install --dev` in your terminal.
+#
+# ⚠️ Make sure you revert these changes before pushing your changes or the
+# pipeline will fail to install the python-package.
+#
+## ℹ️ HOW-TO: Install a new version of the python-package.
+#
+# 1. Uncomment the git-codeforlife package under [packages].
+# 2. Uncomment the git-codeforlife package under [dev-packages].
+# 3. Comment out the editable-codeforlife package under [dev-packages].
+# 4. Set the ref key of the git-codeforlife packages under [packages] and
+#     [dev-packages] to have the same version number.
+# 5. Run `pipenv install --dev` in your terminal.
+
 [packages]
 codeforlife = {ref = "v0.8.3", git = "https://github.com/ocadotechnology/codeforlife-package-python.git"}
-django = "==3.2.20"
-djangorestframework = "==3.13.1"
-django-cors-headers = "==4.1.0"
-# https://pypi.org/user/codeforlife/
-cfl-common = "==6.37.1" # TODO: remove
-codeforlife-portal = "==6.37.1" # TODO: remove
-aimmo = "==2.10.6" # TODO: remove
-rapid-router = "==5.11.3" # TODO: remove
-phonenumbers = "==8.12.12" # TODO: remove
+# 🚫 Don't add [packages] below that are inhertited from the CFL package
 
 [dev-packages]
-black = "*"
-pytest-django = "==4.5.2"
-pytest = "==7.*"
-pytest-env = "==0.8.2"
+codeforlife = {ref = "v0.8.3", git = "https://github.com/ocadotechnology/codeforlife-package-python.git", extras = ["dev"]}
+# codeforlife = {file = "../../codeforlife-package-python", editable = true, extras = ["dev"]}
+# 🚫 Don't add [dev-packages] below that are inhertited from the CFL package.
 
 [requires]
 python_version = "3.8"