git submodule approach to consuming common

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "common"]
+	path = common
+	url = https://github.com/NHSDigital/clinical-data-common.git

.vscode/settings.json

@@ -45,6 +45,9 @@
   "python.analysis.showOnlyDirectDependenciesInAutoImport": true,
   "python.analysis.autoImportCompletions": true,
   "python.analysis.autoIndent": false,
+  "python.analysis.extraPaths": [
+    "${workspaceFolder}/common/src"
+  ],
   // Mypy configuration
   "mypy-type-checker.cwd": "${nearestConfig}",
   // Enable re-format on type

gateway-api/pyproject.toml

@@ -53,3 +53,4 @@ dev = [
 
 [tool.mypy]
 strict = true
+mypy_path = "../common/src"

gateway-api/src/gateway_api/handler.py

@@ -1,3 +1,6 @@
+from clinical_data_common import get_hello
+
+
 class User:
     def __init__(self, name: str):
         self._name = name
@@ -10,4 +13,5 @@ def name(self) -> str:
 def greet(user: User) -> str:
     if user.name == "nonexistent":
         raise ValueError("nonexistent user provided.")
-    return f"Hello, {user.name}!"
+    greeting = get_hello()
+    return f"{greeting}{user.name}!"

pytest.ini

@@ -1,2 +1,3 @@
 [pytest]
 bdd_features_base_dir = gateway-api/tests/acceptance/features
+pythonpath = common/src

scripts/githooks/check-english-usage.sh

@@ -31,16 +31,16 @@ function main() {
   check=${check:-working-tree-changes}
   case $check in
     "all")
-      filter="git ls-files"
+      filter="git ls-files | grep -v '^common/'"
       ;;
     "staged-changes")
-      filter="git diff --diff-filter=ACMRT --name-only --cached"
+      filter="git diff --diff-filter=ACMRT --name-only --cached | grep -v '^common/'"
       ;;
     "working-tree-changes")
-      filter="git diff --diff-filter=ACMRT --name-only"
+      filter="git diff --diff-filter=ACMRT --name-only | grep -v '^common/'"
       ;;
     "branch")
-      filter="git diff --diff-filter=ACMRT --name-only ${BRANCH_NAME:-origin/main}"
+      filter="git diff --diff-filter=ACMRT --name-only ${BRANCH_NAME:-origin/main} | grep -v '^common/'"
       ;;
     *)
       echo "Unrecognised check mode: $check" >&2 && exit 1

scripts/githooks/check-file-format.sh

@@ -81,7 +81,7 @@ function run-editorconfig-natively() {
 
   # shellcheck disable=SC2046,SC2086
   editorconfig \
-    --exclude '.git/' $dry_run_opt $($filter)
+    --exclude '.git/' --exclude 'common/' $dry_run_opt $($filter)
 }
 
 # Run editorconfig in a Docker container.
@@ -101,7 +101,7 @@ function run-editorconfig-in-docker() {
   docker run --rm --platform linux/amd64 \
     --volume "$PWD":/check \
     "$image" \
-      sh -c "ec --exclude '.git/' $dry_run_opt \$($filter) /dev/null"
+      sh -c "ec --exclude '.git/' --exclude 'common/' $dry_run_opt \$($filter) /dev/null"
 }
 
 # ==============================================================================

scripts/githooks/check-markdown-format.sh

@@ -72,7 +72,8 @@ function run-markdownlint-natively() {
   # shellcheck disable=SC2086
   markdownlint \
     $files \
-    --config "$PWD/scripts/config/.markdownlint.yaml"
+    --config "$PWD/scripts/config/.markdownlint.yaml" \
+    --ignore "common/**"
 }
 
 # Run markdownlint in a Docker container.
@@ -90,7 +91,8 @@ function run-markdownlint-in-docker() {
     --volume "$PWD":/workdir \
     "$image" \
       $files \
-      --config /workdir/scripts/config/.markdownlint.yaml
+      --config /workdir/scripts/config/.markdownlint.yaml \
+      --ignore \"common/**\"
 }
 
 # ==============================================================================