Merge branch 'python-version-increment-3.12'

pacharanero · pacharanero · commit b895831190f1 · 2025-07-15T12:54:53.000+01:00
diff --git a/.github/workflows/github-pages-docs-publish.yml b/.github/workflows/github-pages-docs-publish.yml
@@ -0,0 +1,31 @@
+# .github/workflows/github-pages-docs-publish.yml
+# This workflow will build the Documentation site and publish it to GitHub Pages
+
+name: github-pages-docs-publish 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache 
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml
@@ -13,16 +13,16 @@ jobs:
     name: Build the distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
+      - uses: actions/checkout@v4 # latest as at Feb 2024
+      - uses: actions/setup-python@v5 # latest as at Feb 2024
         with:
           python-version: 3.11
 
       - run: |
           pip install poetry
           poetry build
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4 # latest as at Feb 2024
         with:
           path: ./dist
 
@@ -38,9 +38,9 @@ jobs:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
     - name: Download package distributions from build job
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4 # latest as at Feb 2024
 
     - name: Publish package distributions to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1 # latest as at Feb 2024
       with:
         packages-dir: artifact
diff --git a/.github/workflows/test-all-branches.yml b/.github/workflows/test-all-branches.yml
@@ -15,12 +15,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4 # latest as at Feb 2024
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5 # latest as at Feb 2024
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
diff --git a/.github/workflows/testpypi-publish.yml b/.github/workflows/testpypi-publish.yml
@@ -13,16 +13,16 @@ jobs:
     name: Build the distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
+      - uses: actions/checkout@v4 # latest as at Feb 2024
+      - uses: actions/setup-python@v5 # latest as at Feb 2024
         with:
           python-version: 3.11
 
       - run: |
           pip install poetry
           poetry build
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4 # latest as at Feb 2024
         with:
           path: ./dist
 
@@ -38,10 +38,10 @@ jobs:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
     - name: Download package distributions from build job
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4 # latest as at Feb 2024
 
     - name: Publish package distributions to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1 # latest as at Feb 2024
       with:
         repository_url: https://test.pypi.org/legacy/
         packages-dir: artifact
diff --git a/docs/_assets/_source-documents/2012 NHS Number Standard Specification.pdf b/docs/_assets/_source-documents/2012 NHS Number Standard Specification.pdf
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -3,7 +3,15 @@ title: Changelog
 authors: Dr Marcus Baw
 ---
 
+## 1.3.5
+
+- Adds Python 3.12 to the supported versions which are tested in the GitHub Action CI/CD pipeline.
+- Removes Python 3.7 from the supported versions which are tested in the GitHub Action CI/CD pipeline.
+- Adds a source document regarding the NHS number specification to the docs/_source-documents folder.
+- Upgrades all GitHub Actions within workflows (eg `actions/checkout@v3`) to latest version of the Node 20-based actions
+
 ## 1.3.4
+
 - Revert of the new logo, minor edits to the documentation, accepted Anchit PR
 - Reverted to plain code rather than Carbon for the code snippets.
 - No changes to Python code
@@ -14,28 +22,27 @@ authors: Dr Marcus Baw
 
 ## 1.3.2
 
-* GitHub action for CI/CD to publish to live PyPi
-* Minor documentation updates
+- GitHub action for CI/CD to publish to live PyPi
+- Minor documentation updates
 
 ## 1.3.1
 
-* Changed to Netlify for documentation site deployment
-* GitHub action for CI/CD to publish to Test PyPi
+- Changed to Netlify for documentation site deployment
+- GitHub action for CI/CD to publish to Test PyPi
 
 ## 1.3.0 (Refactor, June 2023)
 
-* GitHub repo is transferred from Andy Law to the Faculty of Clinical Informatics.
-* Extensive refactor to add new features such as generation of NHS numbers.
-* Adds documentation site published to GitHub Pages with GitHub Actions publication.
-* Adds GitHub Actions for CI/CD to publish to PyPI.
-* Python version support added for 3.11
-* Python version support dropped for 3.5, Python 2, etc
-
+- GitHub repo is transferred from Andy Law to the Faculty of Clinical Informatics.
+- Extensive refactor to add new features such as generation of NHS numbers.
+- Adds documentation site published to GitHub Pages with GitHub Actions publication.
+- Adds GitHub Actions for CI/CD to publish to PyPI.
+- Python version support added for 3.11
+- Python version support dropped for 3.5, Python 2, etc
 
 ## 1.2.2
 
-* Adds support for additional Python versions (3.8, 3.9, 3.10).
+- Adds support for additional Python versions (3.8, 3.9, 3.10).
 
 ## 1.2.1
 
-* Original package is known as `nhs-number` on PyPI and [NhsNumberChecks](https://github.com/andylaw/NhsNumberChecks) on GitHub.
+- Original package is known as `nhs-number` on PyPI and [NhsNumberChecks](https://github.com/andylaw/NhsNumberChecks) on GitHub.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,20 +4,20 @@ site_name: nhs-number
 repo_url: https://github.com/uk-fci/nhs-number
 repo_name: uk-fci/nhs-number
 
-copyright: Copyright &copy; 2021-2023 Andy Law, The University of Edinburgh, and the Faculty of Clinical Informatics
+copyright: Copyright &copy; 2021-2025 Andy Law, The University of Edinburgh, Marcus Baw, and the Faculty of Clinical Informatics (now defunct)
 
 # explicitly defines the Nav so we can set order of pages other than default alphabetical
 nav:
   - Introduction:
-    - "index.md"
-    - About NHS Numbers: "nhs-numbers.md"
+      - "index.md"
+      - About NHS Numbers: "nhs-numbers.md"
   - Getting Started:
-    - Installation: "installation.md"
-    - Usage: "usage.md"
+      - Installation: "installation.md"
+      - Usage: "usage.md"
   - Developer Guide:
-    - Project Structure: "developing.md"
-    - Documentation: 'documentation.md'
-    - Useful URLs: "useful_urls.md"
+      - Project Structure: "developing.md"
+      - Documentation: "documentation.md"
+      - Useful URLs: "useful_urls.md"
   - Contributors: "contributors.md"
   - Changelog: "changelog.md"
 
@@ -35,7 +35,7 @@ theme:
   icon:
     logo: material/check-all
   favicon: _assets/_images/done_all.svg
-  custom_dir: 'overrides'
+  custom_dir: "overrides"
   features:
     - content.action.edit # explicitly adds edit button (Material4MkDocs9.0)
     - content.action.view # explicitly adds view button (Material4MkDocs9.0)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "nhs-number"
-version = "1.3.4"
+version = "1.3.5"
 description = "Python package to provide utilities for NHS Numbers, including validity checks, normalisation, and generation."
 authors = [
     "Andy Law <andy.law@roslin.ed.ac.uk>",
-    "Marcus Baw <marcusbaw@gmail.com>",
+    "Marcus Baw <marcus@marcusbaw.com>",
     ]
 license = "MIT"
 readme = "README.md"
@@ -24,22 +24,21 @@ classifiers = [
     'Intended Audience :: Healthcare Industry',
     'Intended Audience :: Science/Research',
     'Topic :: Scientific/Engineering :: Medical Science Apps.',
-    'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
     ]
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.8"
 
 [tool.poetry.dev-dependencies]
-pytest = "^7.3.1"
+pytest = "^8.0.0"
 black = "^23.3.0"
 mkdocs-material = "^9.1.15"
 
-
 [tool.poetry.urls]
 "Issue Tracker" = "https://github.com/uk-fci/nhs-number/issues"
 
