.github/dependabot.yml

@@ -6,3 +6,9 @@ updates:
       interval: "daily"
     ignore:
       - dependency-name: pyspark
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "daily"
+    ignore:
+      - dependency-name: abatilo/actions-poetry

.github/pull_request_template.md

@@ -1,17 +1,13 @@
-# Checklist
+## Synopsis
 
-- [ ] Documentation created/updated
-    - [ ] If documentation descoped, a JIRA Ticket has been created to complete
-      the documentation
-
-- [ ] Deployed and tested in a sandbox/dev environment
-- [ ] Confirmed that no breakage to contract with automated testing/other teams
-  and remedial PRs or tickets raised.
+Briefly describe the purpose of the pr.
 
-Please briefly summarise how the PR has been tested:
+## Checklist
 
-## JIRA references
+- [ ] Documentation created/updated
+- [ ] Tests created/updated
 
-**Feature:** SPP-
+## Description
 
-**Task/Story:** SPP-
+Add a more detailed description of the pr if necessary (can reference release
+notes if included).

.github/workflows/ci-checks.yaml

@@ -2,148 +2,90 @@ name: CI Checks
 
 on: [push]
 
+permissions:
+  statuses: write
+  checks: write
+  contents: read
+
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.7]
-        java-version: ['8']
-      fail-fast: false 
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'adopt'
-          java-version: ${{ matrix.java-version }}
-      - name: Run image
-        uses: abatilo/actions-poetry@v2.0.0
-        with:
-          poetry-version: 1.1.6
-      - name: Install dependencies
-        run: poetry install
-      - name: build
-        run: poetry build
   test:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
         java-version: ['8']
       fail-fast: false 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
           java-version: ${{ matrix.java-version }}
-      - name: Run image
-        uses: abatilo/actions-poetry@v2.0.0
-        with:
-          poetry-version: 1.1.6
-      - name: Install dependencies
-        run: poetry install
-      - name: test
-        run: poetry run pytest --tap-stream --cov-report=html --junitxml=junit.xml
-      - name: Upload Test report
+      - name: Run image ${{matrix.python-version}}
+        uses: abatilo/actions-poetry@v2.4.0
+        with:
+          poetry-version: 1.5.1
+      - name: Test ${{matrix.python-version}}
+        run: |-
+          set -e
+          poetry install
+          poetry run pytest --tap-stream --cov-report=lcov:lcov-${{matrix.python-version}}.info --junitxml=junit-${{matrix.python-version}}.xml
+      - name: Upload Test report ${{matrix.python-version}}
         uses: dorny/test-reporter@v1
         if: success() || failure()
         with:
-          name: test-results
-          path: junit.xml
+          name: test-results-${{matrix.python-version}}
+          path: junit-${{matrix.python-version}}.xml
           reporter: java-junit
-          fail-on-error: false
-      - name: upload-coverage-report
-        uses: actions/upload-artifact@v2
+      - name: upload-coverage-report-${{matrix.python-version}}
+        uses: actions/upload-artifact@v4
         with:
-          name: coverage-report
-          path: htmlcov/
-          if-no-files-found: warn
+          name: coverage-report-${{matrix.python-version}}-lcov
+          path: lcov-${{matrix.python-version}}.info
   flake8:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
         python-version: [3.7]
-        java-version: ['8']
-      fail-fast: false 
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'adopt'
-          java-version: ${{ matrix.java-version }}
-      - name: Run image
-        uses: abatilo/actions-poetry@v2.0.0
-        with:
-          poetry-version: 1.1.6
-      - name: Install dependencies
-        run: poetry install
-      - name: run flake8
-        run: poetry run flake8 statistical_methods_library tests
-  isort:
-    runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.7]
-        java-version: ['8']
       fail-fast: false 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'adopt'
-          java-version: ${{ matrix.java-version }}
       - name: Run image
-        uses: abatilo/actions-poetry@v2.0.0
+        uses: abatilo/actions-poetry@v2.4.0
         with:
-          poetry-version: 1.1.6
-      - name: Install dependencies
-        run: poetry install
-      - name: run isort
-        run: poetry run isort --check-only statistical_methods_library tests
+          poetry-version: 1.5.1
+      - name: Run flake8
+        run: |-
+          poetry install
+          poetry run flake8 statistical_methods_library tests
   black:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
         python-version: [3.7]
-        java-version: ['8']
       fail-fast: false 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'adopt'
-          java-version: ${{ matrix.java-version }}
       - name: Run image
-        uses: abatilo/actions-poetry@v2.0.0
+        uses: abatilo/actions-poetry@v2.4.0
         with:
-          poetry-version: 1.1.6
-      - name: Install dependencies
-        run: poetry install
-      - name: run black
-        run: poetry run black --check --diff statistical_methods_library tests
+          poetry-version: 1.5.1
+      - name: Run Black
+        run: |-
+          poetry install
+          poetry run black --check --diff statistical_methods_library tests

.github/workflows/dependabot-auto-merge.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.actor == 'dependabot[bot]' && github.event.workflow_run.conclusion == 'success' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.workflow_run.head_branch }}
       - name: Auto-approve Dependabot PR

.github/workflows/release-code.yml

@@ -0,0 +1,34 @@
+name: Release code
+
+on:
+  push:
+    tags:
+     - "*"
+
+jobs:
+  build:
+    name: Build and release artifact
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      fail-fast: false 
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Run image
+        uses: abatilo/actions-poetry@v3.0.0
+        with:
+          poetry-version: 1.5.1
+      - name: build
+        run: poetry build
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -121,8 +121,8 @@ venv.bak/
 .devcontainer/
 # Editor backup files
 *~
-# portray generated docs
-site/
+
 # asdf tool versions
 .tool-versions
-
+# libreoffice lock files (sometimes used when editing csvs)
+*.~lock.*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Crown Copyright (Office for National Statistics)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

catalog-info.yaml

@@ -0,0 +1,18 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: statistical-methods-library
+  description: The Statistical Methods Library (S.M.L.) is a set of approved statistical methods.
+  annotations:
+    jira/project-key: SPP
+    github.com/project-slug: ONSdigital/statistical-methods-library
+  tags:
+    - python
+    - spp
+    - sml
+  links:
+      icon: search
+spec:
+  type: library
+  lifecycle: production
+  owner: group:spp-results