scalelink 1.0.0__tar.gz

scalelink-1.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ONSdigital/scalelink-maintainers

scalelink-1.0.0/.github/dependabot.yml

@@ -0,0 +1,39 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      pip-major:
+        update-types:
+          - "major"
+      pip-minor-patch:
+        update-types:
+          - "minor"
+          - "patch"
+    target-branch: "develop"
+    labels:
+      - "dependabot"
+    cooldown:
+      default-days: 14
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions-major:
+        update-types:
+          - "major"
+      actions-minor-patch:
+        update-types:
+          - "minor"
+          - "patch"
+    target-branch: "develop"
+    labels:
+      - "dependabot"
+      - "github actions"
+    cooldown:
+      default-days: 14

scalelink-1.0.0/.github/pull_request_template.md

@@ -0,0 +1,92 @@
+# Request
+
+This section must be completed by the person making the pull request.
+
+## Description
+
+Please **replace this text** with a summary of the changes, using the following prompts:
+
+  - What has been changed?
+  - Why was it changed?
+  - How has the change been tested?
+  - Does the change close or contribute to closing any issues? Use [GitHub keywords][keywords] and
+    [cite][issue-citation] relevant issues.
+
+## Type of change
+
+Please check all items that are applicable:
+
+- [ ] New feature - change that adds new documentation, functionality, etc.
+- [ ] Refactor - change that alters existing files, but not to fix an error.
+- [ ] Bugfix - change that alters existing files to fix an error.
+- [ ] Breaking change - backwards incompatible change, changes expected behaviour, etc.
+- [ ] Non-user-facing change e.g. structural change, CI/CD change, etc.
+
+## Checklist:
+
+Please check all items that have been completed. If any are not completed, provide an explanation in the description.
+
+- [ ] **Assignee:** I have marked myself as the assignee of this pull request.
+- [ ] **Code:** I have performed a self-review of my own code.
+- [ ] **Tests: I have:**
+  - [ ] Added tests that prove my fix is effective or that my feature works.
+  - [ ] Checked that new and existing unit tests pass locally with my changes.
+- [ ] **Documentation:** I have:
+  - [ ] Made corresponding changes to the documentation (comments, docstring, etc.).
+  - [ ] Commented my code appropriately, focusing on explaining my design decisions (explain why, not how).
+- [ ] **Style:** I have followed the [contribution guide][contribution-guide].
+- [ ] **Admin:** I have:
+  - [ ] Updated the change log.
+  - [ ] Labelled this pull request appropriately.
+
+#  Review
+
+This section must be completed by the person or persons reviewing the pull request.
+
+## Checklist
+
+Please check all items that have been completed:
+
+-   [ ] **Reviewer**: I have marked myself as the reviewer on this pull request.
+-   [ ] **Code**: I confirm that code changes:
+    - Work as expected.
+    - Are not overly complex.
+    - Are appropriately documented.
+    - Handle edge cases and exceptions.
+-   [ ] **Tests**: I confirm that unit tests:
+    - Are present where appropriate.
+    - Cover essential functions for a reasonable range of inputs and conditions.
+    - Pass locally (both new and existing tests).
+-   [ ] **Documentation**: I confirm that documentation files:
+    - Have been added/updated, as applicable.
+    - Make sense.
+    - Are not overly complex.
+-   [ ] **Style**: I confirm that all changes conform to the [contribution guide][contribution-guide].
+
+Where items in this checklist are not met, suggestions for improvement must be made using review comments.
+
+## Review comments
+
+Suggestions should be tailored to the code that you are reviewing. Provide context. Be critical and clear, but not mean.
+Ask questions and set actions.
+
+Suggestions may include:
+
+-   **Documentation improvements**:
+    - Improve clarity.
+    - Minimise complexity.
+    - Ensure all necessary information is covered accurately.
+-   **Code improvements**:
+    - Ensure correct functioning.
+    - Minimise complexity.
+    - Ensure all code is documented sufficiently.
+    - Ensure edge cases and exceptions are handled.
+-   **Test improvements**:
+    - Ensure sufficient coverage of both functions and inputs/conditions.
+    - Ensure all tests pass.
+-   **Style improvements**:
+    - Ensure the [contribution guide][contribution-guide] is followed.
+
+[contribution-guide]: /docs/contribution_guide.md
+[issue-citation]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests
+[keywords]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests

scalelink-1.0.0/.github/workflows/deploy_to_pypi.yaml

@@ -0,0 +1,52 @@
+name: Deploy version to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tags:
+        description: "Version to deploy, e.g. 1.0.0"
+        required: true
+        type: string
+
+jobs:
+  release-build:
+    name: Build and verify release distributions
+    runs-on: ubuntu-latest
+    permissions:
+      # allows the provenance attestation to work
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Check out repository
+        id: build-repo-checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+
+      - name: Build and lint dist
+        id: build-dist
+        uses: hynek/build-and-inspect-python-package@2abe76da66d0a6a4a227101f9348ee855797cfa5
+        with:
+          attest-build-provenance-github: 'true'
+
+  release-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs: release-build
+    permissions:
+      # mandatory for PyPI Trusted Publishing
+      id-token: write
+    environment:
+      name: pypi
+    steps:
+      - name: Retrieve release distributions
+        id: publish-retrieve-dist
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
+        with:
+          name: Packages
+          path: dist/
+
+      - name: Publish release distributions on PyPI
+        id: publish-to-pypi
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33
+        with:
+          skip-existing: true

scalelink-1.0.0/.github/workflows/deploy_to_test_pypi.yaml

@@ -0,0 +1,52 @@
+name: Deploy version to Test PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tags:
+        description: "Version to deploy, e.g. 1.0.0-dev"
+        required: true
+        type: string
+
+jobs:
+  release-build:
+    name: Build and verify release distributions
+    runs-on: ubuntu-latest
+    permissions:
+      # allows the provenance attestation to work
+      attestations: write
+      id-token: write
+    steps:
+      - name: Check out repository
+        id: build-repo-checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+
+      - name: Build and lint dist
+        id: build-dist
+        uses: hynek/build-and-inspect-python-package@2abe76da66d0a6a4a227101f9348ee855797cfa5
+        with:
+          attest-build-provenance-github: 'true'
+
+  release-publish:
+    name: Upload release to Test PyPI
+    runs-on: ubuntu-latest
+    needs: release-build
+    permissions:
+      # mandatory for PyPI Trusted Publishing
+      id-token: write
+    environment:
+      name: test-pypi
+    steps:
+      - name: Retrieve release distributions
+        id: publish-retrieve-dist
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
+        with:
+          name: Packages
+          path: dist/
+
+      - name: Publish release distributions on Test PyPI
+        id: publish-to-pypi
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true

scalelink-1.0.0/.github/workflows/increment_version.yaml

@@ -0,0 +1,44 @@
+name: Increment version
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  version-increment:
+    permissions:
+      contents: write
+      actions: write
+    name: Increment repo version, push tag and create release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        id: version-repo-checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+
+      - name: Check version
+        id: version-check
+        uses: maybe-hello-world/pyproject-check-version@cb964e82b3c8a0b1cedb117da63e1761c46600b8
+        with:
+          pyproject-path: "./pyproject.toml"
+
+      - name: Set version as env variable
+        id: version-set
+        run: |
+          echo "PACKAGE_VERSION=${{ steps.version-check.outputs.local_version }}" >> $GITHUB_ENV
+
+      - name: Bump version and push tag
+        id: version-tag
+        uses: mathieudutour/github-tag-action@af99e60ce8132224b8e6ebab5023449fe256ed46
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          custom_tag: ${{ env.PACKAGE_VERSION }}
+
+      - name: Create a GitHub release
+        id: version-release
+        uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd
+        with:
+          tag: ${{ steps.version-tag.outputs.new_tag }}
+          name: Release ${{ steps.version-tag.outputs.new_tag }}
+          body: ${{ steps.version-tag.outputs.changelog }}

scalelink-1.0.0/.github/workflows/pull_request.yaml

@@ -0,0 +1,80 @@
+name: Pull request workflow
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+permissions:
+  contents: read
+
+jobs:
+  check-branch:
+    # Source: https://stackoverflow.com/questions/71120146/
+    name: Enforce only develop can merge into main
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch
+        id: check-branch
+        if: ${{ github.base_ref == 'main' && (github.head_ref != 'develop') }}
+        run: |
+          echo "ERROR: You can only merge to main from develop."
+          exit 1
+
+  changelog:
+    name: Check for changelog update
+    runs-on: ubuntu-latest
+    needs: check-branch
+    steps:
+      - name: Check changelog
+        id: changelog
+        uses: dangoslen/changelog-enforcer@8b5e9dc3121363bb7c0115f8533404d92af382de
+
+  pre-commit:
+    name: Run pre-commit hooks
+    runs-on: ubuntu-latest
+    needs: changelog
+    steps:
+      - name: Check out repository
+        id: pre-commit-repo-checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+
+      - name: Set up Python
+        id: pre-commit-python-set-up
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
+
+      - name: Run pre-commit hooks
+        id: pre-commit-run
+        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd
+
+  test:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    needs: pre-commit
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+      - name: Check out repository
+        id: test-repo-checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+
+      - name: Set up Python ${{ matrix.python-version }}
+        id: test-python-set-up
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install system dependencies
+        # This prevents failure of raz_client to install due to dependency on krb5-config
+        run: sudo apt-get update && sudo apt-get install -y libkrb5-dev
+
+      - name: Install dependencies
+        id: test-dependency-install
+        run: |
+          python -m pip install --upgrade pip
+          pip3 install .
+          pip3 install --group test
+
+      - name: Run unit tests
+        id: test-run
+        run: pytest

scalelink-1.0.0/.gitignore

@@ -0,0 +1,278 @@
+# Byte-compiled / optimised / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyser
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Compressed filetypes
+*.7z
+*.pickle
+*.pkl
+*.pyc
+*.tar.*
+*.taz
+*.taZ
+*.tb2
+*.tbz
+*.tbz2
+*.tgz
+*.tlz
+*.txz
+*.tZ
+*.tz2
+*.tzst
+
+# Data filetypes
+*.arvo
+*.bson
+*.csv
+*.dat
+*.fbs
+*.feather
+*.h5
+*.hd
+*.hdf5
+*.ndjson
+*.orc
+*.parquet
+*.proto
+*.sav
+*.tsv
+*.xls
+*.xlsx
+*.xml
+
+# Files containing env and secret variables
+*.cert
+*.crt
+*.csr
+*.env
+*.envrc
+*.httr-oauth
+*.key
+*.p12
+*.pem
+*.pgp
+*.ssh
+*.venv
+env/
+ENV/
+env.bak/
+.ssh/
+venv/
+venv.bak/

scalelink-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    - id: check-added-large-files
+    - id: check-merge-conflict
+      args: ["--assume-in-merge"]
+    - id: check-toml
+    - id: check-yaml
+    - id: debug-statements
+    - id: detect-aws-credentials
+      args:
+      - --allow-missing-credentials
+    - id: detect-private-key
+    - id: end-of-file-fixer
+    - id: name-tests-test
+      args: ["--pytest-test-first"]
+    - id: no-commit-to-branch  # Protects main by default
+    - id: trailing-whitespace
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.9.1
+    hooks:
+    - id: nbstripout
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.1
+    hooks:
+    - id: ruff-check  # Linter
+      args: [--fix]
+    - id: ruff-format  # Formatter
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.48.0
+    hooks:
+    - id: typos
+      name: Commit message typos
+      args: []  # Turns off automatic fixing
+      stages: [commit-msg]
+    - id: typos
+      name: Script typos
+      args: []  # Turns off automatic fixing
+      stages: [pre-commit]
+
+#  - repo: https://github.com/gitleaks/gitleaks
+#    rev: v8.30.1
+#    hooks:
+#    - id: gitleaks
+
+  - repo: local
+    hooks:
+      - id: restricted-filenames
+        name: Restricted filenames
+        entry: These file extensions are restricted. Data should be removed from the commit
+        language: fail
+        files: .*\.(arvo|bson|csv|dat|fbs|feather|h5|hd|hdf5|ndjson|orc|parquet|proto|sav|tsv|xls|xlsx|xml)