[ERSSUP-76481]-[JW]-[Upgrade to python 3.10]-[DMW]

Author: nhsd-david-wass

.github/workflows/continous-integration-workflow.yaml

@@ -12,10 +12,10 @@ jobs:
         with:
           fetch-depth: 0  # This causes all history to be fetched, which is required for calculate-version to function
 
-      - name: Install Python 3.8
+      - name: Install Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: '3.10'
 
       - name: Upgrade python packaging tools
         run: python -m pip install --upgrade pip setuptools wheel

README.md

@@ -35,7 +35,7 @@ The contents of this repository are protected by Crown Copyright (C).
 ### Environment setup
 Currently, automation for setting up the right environment is only available for machines based on RedHatEnterpriseLinux (RHEL).
 Running the following will ensure your environment is ready for development.
-It will install [pyenv](https://github.com/pyenv/pyenv), Python 3.8.12 and its dependencies (yum), create a virtual environment (named apigee), and ensure poetry is installed under it.
+It will install [pyenv](https://github.com/pyenv/pyenv), Python 3.10.8 and its dependencies (yum), create a virtual environment (named apigee), and ensure poetry is installed under it.
 ```
 $ make setup-environment
 ```

azure/azure-build-pipeline.yml

@@ -17,7 +17,7 @@ resources:
     - repository: common
       type: github
       name: NHSDigital/api-management-utils
-      ref: refs/heads/edge
+      ref: refs/heads/master
       endpoint: NHSDigital
 
 variables:
@@ -27,3 +27,4 @@ extends:
   parameters:
     service_name: ${{ variables.service_name }}
     short_service_name: ${{ variables.short_service_name }}
+    python_version: ${{ variables.python_version }}

azure/azure-pr-pipeline.yml

@@ -8,7 +8,7 @@ resources:
     - repository: common
       type: github
       name: NHSDigital/api-management-utils
-      ref: refs/heads/edge
+      ref: refs/heads/master
       endpoint: NHSDigital
   pipelines:
     - pipeline: build_pipeline
@@ -33,6 +33,7 @@ extends:
     short_service_name: ${{ variables.short_service_name }}
     service_base_path: ${{ variables.service_base_path }}
     manual_approval_env: manual-approval-ptl
+    python_version: ${{ variables.python_version }}
     apigee_deployments:
       - environment: manual-approval
         stage_name: manual_approval_alpha_pr

azure/azure-release-pipeline.yml

@@ -8,7 +8,7 @@ resources:
     - repository: common
       type: github
       name: NHSDigital/api-management-utils
-      ref: refs/heads/edge
+      ref: refs/heads/master
       endpoint: NHSDigital
   pipelines:
     - pipeline: build_pipeline
@@ -33,6 +33,7 @@ extends:
     enable_status_monitoring: true
     manual_approval_env: manual-approval-ptl
     prod_producer_approval: true
+    python_version: ${{ variables.python_version }}
     apigee_deployments:
     - environment: manual-approval
       stage_name: ers_manual_approval_alpha

azure/project.yml

@@ -5,3 +5,4 @@ variables:
   product_display_name: e-Referrals-Service
   product_description: The NHS e-RS vision is to enable local innovation and adoption of paperless referrals. To support this vision NHS Digital have created a set of APIs which provide a well-defined, simple to use data interface to the NHS e-Referral Service (e-RS). See https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir
   spec_file: e-referrals-service-api.json
+  python_version: 3.10

poetry.lock

@@ -20,7 +20,7 @@ keywords = ["healthcare", "uk", "nhs"] #TODO add additional keywords
 
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.10"
 pyyaml = "^6.0"
 docopt = "^0.6.2"
 jsonpath-rw = "^1.4.0"

pyproject.toml

@@ -40,34 +40,34 @@ echo "Installing python dependencies"
 brew update
 if brew install openssl readline sqlite3 zlib xz ; then
     echo "Python dependencies were installed successfully."
-else 
+else
     echo "Python dependencies were NOT installed correctly."
     exit 2
 fi
 
-# Installing python 3.8.12 with pyenv
-echo "Installing python 3.8.12 with pyenv ..."
-if pyenv versions | grep -Fq "3.8.12" ; then
-    echo "Pyenv has already got Python 3.8.12 installed."
+# Installing python 3.10.8 with pyenv
+echo "Installing python 3.10.8 with pyenv ..."
+if pyenv versions | grep -Fq "3.10.8" ; then
+    echo "Pyenv has already got Python 3.10.8 installed."
 else
-    if pyenv install 3.8.12 ; then
-        echo "Pyenv installed Python 3.8.12 successfully."
+    if pyenv install 3.10.8 ; then
+        echo "Pyenv installed Python 3.10.8 successfully."
     else
-        echo "Pyenv did NOT install Python 3.8.12 successfully."
+        echo "Pyenv did NOT install Python 3.10.8 successfully."
         exit 3
     fi
 fi
 
 
-# Creating Apigee environment with Python 3.8.12
-echo "Creating Apigee environment with Python 3.8.12 ..."
+# Creating Apigee environment with Python 3.10.8
+echo "Creating Apigee environment with Python 3.10.8 ..."
 if pyenv versions | grep -q ".*apigee" ; then
     echo "A Python virtualenv named 'apigee' already exists."
 else
-    if pyenv virtualenv 3.8.12 apigee ; then
-        echo "A Python 3.8.12 virtualenv named 'apigee' was created."
+    if pyenv virtualenv 3.10.8 apigee ; then
+        echo "A Python 3.10.8 virtualenv named 'apigee' was created."
     else
-        echo "A Python 3.8.12 virtualenv named 'apigee' was NOT created."
+        echo "A Python 3.10.8 virtualenv named 'apigee' was NOT created."
         exit 4
     fi
 fi
@@ -86,7 +86,7 @@ fi
 # Checking python version
 echo "Checking python version ..."
 version=$(python -V 2>&1)
-if [[ $version = 'Python 3.8.12' ]] ; then
+if [[ $version = 'Python 3.10.8' ]] ; then
     echo "Python version is correct."
 else
     echo "Python version is NOT correct."
@@ -126,4 +126,4 @@ Please \033[1mopen another terminal\033[0m to update your \$PATH and run:\n \
 \033[1m$ pyenv version\033[0m, which should output 'apigee'\n \
 \033[1m$ make install\033[0m to finish environment setup.\n \
 If something went wrong during the setup scripts, you can execute\n \
-\033[1m$ make clean-environment\033[0m (N.B. This will remove the ~/.pyenv directory)\n\n"
+\033[1m$ make clean-environment\033[0m (N.B. This will remove the ~/.pyenv directory)\n\n"

scripts/macos_setup_environment.sh

@@ -63,29 +63,29 @@ else
 fi
 
 
-#Installing python 3.8.12 with pyenv
-echo "Installing python 3.8.12 with pyenv ..."
-if pyenv versions | grep -Fq "3.8.12" ; then
-    echo "Pyenv has already got Python 3.8.12 installed."
+#Installing python 3.10.8 with pyenv
+echo "Installing python 3.10.8 with pyenv ..."
+if pyenv versions | grep -Fq "3.10.8" ; then
+    echo "Pyenv has already got Python 3.10.8 installed."
 else
-    if pyenv install 3.8.12 ; then
-        echo "Pyenv installed Python 3.8.12 successfully."
+    if pyenv install 3.10.8 ; then
+        echo "Pyenv installed Python 3.10.8 successfully."
     else
-        echo "Pyenv did NOT install Python 3.8.12 successfully."
+        echo "Pyenv did NOT install Python 3.10.8 successfully."
         exit 1
     fi
 fi
 
 
-#Creating Apigee environment with Python 3.8.12
-echo "Creating Apigee environment with Python 3.8.12 ..."
+#Creating Apigee environment with Python 3.10.8
+echo "Creating Apigee environment with Python 3.10.8 ..."
 if pyenv versions | grep -q ".*apigee" ; then
     echo "A Python virtualenv named 'apigee' already exists."
 else
-    if pyenv virtualenv 3.8.12 apigee ; then
-        echo "A Python 3.8.12 virtualenv named 'apigee' was created."
+    if pyenv virtualenv 3.10.8 apigee ; then
+        echo "A Python 3.10.8 virtualenv named 'apigee' was created."
     else
-        echo "A Python 3.8.12 virtualenv named 'apigee' was NOT created."
+        echo "A Python 3.10.8 virtualenv named 'apigee' was NOT created."
         exit 1
     fi
 fi
@@ -104,7 +104,7 @@ fi
 #Checking python version
 echo "Checking python version ..."
 version=$(python -V 2>&1)
-if [[ $version = 'Python 3.8.12' ]] ; then
+if [[ $version = 'Python 3.10.8' ]] ; then
     echo "Python version is correct."
 else
     echo "Python version is NOT correct."