Merge pull request #723 from robbrad/python_3_12_support

feat: #722 Support Python 3.12

.devcontainer/dev.Dockerfile

@@ -1,12 +1,12 @@
-ARG VARIANT="3.11-bullseye"
+ARG VARIANT="3.12-bullseye"
 FROM mcr.microsoft.com/devcontainers/python:${VARIANT} AS ukbc-dev-base
 
 USER vscode
 
 # Define the version of Poetry to install (default is 1.4.2)
 # Define the directory of python virtual environment
 ARG PYTHON_VIRTUALENV_HOME=/home/vscode/ukbc-py-env \
-    POETRY_VERSION=1.5.1
+    POETRY_VERSION=1.8.3
 
 ENV POETRY_VIRTUALENVS_IN_PROJECT=false \
     POETRY_NO_INTERACTION=true 

.github/workflows/behave.yml

@@ -25,8 +25,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.10', 3.11]
-        poetry-version: [1.5.1]
+        python-version: [3.11, 3.12]
+        poetry-version: [1.8.3]
     services:
       selenium:
         image: selenium/standalone-chrome:latest
@@ -42,7 +42,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'poetry'
+          #cache: 'poetry'
 
       - name: Install
         run: make install
@@ -126,16 +126,17 @@ jobs:
     needs: build
     if: github.ref == 'refs/heads/master'
     steps:
+
       - uses: actions/download-artifact@v4
-        name: Download 3.10 artifacts
+        name: Download 3.11 artifacts
         with:
-          name: allure_history_3.10
+          name: allure_history_3.11
           path: allure-history/tars
 
       - uses: actions/download-artifact@v4
-        name: Download 3.11 artifacts
+        name: Download 3.12 artifacts
         with:
-          name: allure_history_3.11
+          name: allure_history_3.12
           path: allure-history/tars
 
       - name: Untar reports

.github/workflows/bump.yml

@@ -24,7 +24,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.12'
 
       - name: Bump version
         id: cz

.github/workflows/release.yml

@@ -16,12 +16,12 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.12'
 
       - name: Run image
         uses: abatilo/[email protected]
         with:
-          poetry-version: '1.5.1'
+          poetry-version: '1.8.3'
 
       - name: Install dependencies
         run: |

.github/workflows/wiki.yml

@@ -25,12 +25,12 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.12'
 
     - name: Run image
       uses: abatilo/[email protected]
       with:
-        poetry-version: '1.5.1'
+        poetry-version: '1.8.3'
 
     - name: Install
       run: make install

CONTRIBUTING.md

@@ -1,27 +1,37 @@
 
 # Contents
+- [Contents](#contents)
 - [Contributor guidelines](#contributor-guidelines)
-  * [Getting Started](#getting-started)
-    + [Environment Setup](#environment-setup)
-  * [Project Aims](#project-aims)
-    + [What can I contribute to?](#what-can-i-contribute-to-)
-  * [Claiming an issue](#claiming-an-issue)
-  * [Pushing your changes](#pushing-your-changes)
+  - [Getting Started](#getting-started)
+    - [Environment Setup](#environment-setup)
+  - [Project Aims](#project-aims)
+    - [What can I contribute to?](#what-can-i-contribute-to)
+  - [Claiming an issue](#claiming-an-issue)
+  - [Pushing your changes](#pushing-your-changes)
 - [Adding a scraper](#adding-a-scraper)
-  * [Developing](#developing)
-    + [Kwargs](#kwargs)
-    + [Common Functions](#common-functions)
-  * [Additional files](#additional-files)
-    + [Input JSON file](#input-json-file)
-    + [Feature file](#feature-file)
-  * [Testing](#testing)
-    + [Behave (Integration Testing)](#behave--integration-testing-)
-      - [Running the Behave tests](#running-the-behave-tests)
+  - [Developing](#developing)
+    - [Developing using our Dev Container](#developing-using-our-dev-container)
+      - [Prerequisites](#prerequisites)
+      - [Step 1: Clone the Repository](#step-1-clone-the-repository)
+      - [Step 2: Set Up Docker](#step-2-set-up-docker)
+      - [Step 3: Open the Project in VSCode](#step-3-open-the-project-in-vscode)
+      - [Step 4: Reopen in Container](#step-4-reopen-in-container)
+      - [Step 5: Verify the Development Environment](#step-5-verify-the-development-environment)
+    - [Developing](#developing-1)
+    - [Kwargs](#kwargs)
+    - [Common Functions](#common-functions)
+  - [Additional files](#additional-files)
+    - [Input JSON file](#input-json-file)
+    - [Feature file](#feature-file)
+  - [Testing](#testing)
+    - [Behave (Integration Testing)](#behave-integration-testing)
+      - [Running the Behave tests for all councils](#running-the-behave-tests-for-all-councils)
+      - [Running the Behave tests for a specific council](#running-the-behave-tests-for-a-specific-council)
       - [GitHub Actions Integration Tests](#github-actions-integration-tests)
       - [Test Results](#test-results)
-        * [Allure Report](#allure-report)
-        * [CodeCov Report](#codecov-report)
-    + [Pytest (Unit Testing)](#pytest--unit-testing-)
+        - [Allure Report](#allure-report)
+        - [CodeCov Report](#codecov-report)
+    - [Pytest (Unit Testing)](#pytest-unit-testing)
       - [Running the Unittests](#running-the-unittests)
 - [Contact info](#contact-info)
 
@@ -32,8 +42,7 @@ This document contains guidelines on contributing to the UKBCD project including
 the environment, how we use our issue tracker, and how you can develop more scrapers.
 
 ## Getting Started
-You will need to install Python on the system you plan to run the script from. Python 3.8 and 3.9 are officially supported.
-Python 3.10 and 3.11 should work, but your mileage _may_ vary.
+You will need to install Python on the system you plan to run the script from. Python 3.11 and 3.12 are tested on this project .
 
 The project uses [poetry](https://python-poetry.org/docs/) to manage dependencies and setup the build environment.
 

README.md

@@ -118,8 +118,8 @@ Please be aware that this project is run by volunteer contributors and completio
 
 ## Reports
 
-- [3.10](https://robbrad.github.io/UKBinCollectionData/3.10/)
 - [3.11](https://robbrad.github.io/UKBinCollectionData/3.11/)
+- [3.12](https://robbrad.github.io/UKBinCollectionData/3.12/)
 
 ---
 ## Docker API Server