Add build configuration

[BNJHope]

Overview

To make the CI/CD workflow easier to distribute and integrate in various pipelines, this adds the configuration to generate a Python artefacts using hatchling as a build backend for Python wheels

Features

• Add pyproject.toml which includes the build configuration for the CICD package
  • requirements[-dev].txt have been removed, with dependency information now in the pyproject.toml
• Add build and publish GitHub Actions workflow that will be triggered on merges to main - it will:
  • Generate a .whl and source build too for the package
  • Create a GitHub Release on the repo that publishes the .whl
• Rename cicd directory to ib_cicd

Testing

Ensuring CICD library code is accessible from the built package

Steps

• Run the build process for the package
  • Created a venv
  • Follow guidelines for building the artefact from python3 -m build in the environment to generate the .whl file
  • Create a test Python project in my local environment
  • Install the generated .whl within the venv of that local project and ensure library contents was accessible after installation

 Outcome: Successful

Side effect: VSCode is happy when it uses the venv for its Python extension environment, has Intellisense over it etc

Ensuring CICD CLI Tool is Runnable after install from

Steps

• Run the build process for the package
  • Created a venv
  • Follow guidelines for building the artefact from python3 -m build in the environment to generate the .whl file
  • Create a test Python project in my local environment
  • Install the generated .whl within the venv of that local project and ensure the CLI can run as expected

 Outcome: Successful

• No import errors on running CLI tool after install

Ensuring GitHub Release is created as expected

Steps

• Run the build/publish action in my own fork of the project with the created configurations

Outcome: Successful

• Release successfully created on personal fork

[hannahflroiter]

Will we need to manually update the version?

[BNJHope]

Yes - the workflow will fail though if it isn't changed before merging into main because it shouldn't overwrite existing tags, so users will get warnings/failures if it hasn't been adjusted.

(We should provide a better system for this in the future)