Usage

Documentation is hosted on ReadTheDocs.

Development

This project has a dev container. If you already have VS Code and Docker installed, you can click the badge above or here to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

To publish a new version of the repository, you can run the Publish workflow manually and publish to the staging registry from any branch, and you can check the 'Publish to Primary' option when on main to publish to the primary registry and create a git tag.

The Release workflow reuses the checks from CI instead of re-running them: it requires that the CI workflow has already completed successfully for the current commit (including the workflow-summary job) and reuses the artifacts CI built rather than rebuilding. Trigger it manually with workflow_dispatch; a real release must be run from main, while the dry_run option lets you exercise the workflow from any branch without tagging or releasing. A real run publishes the CI-built distribution to the staging registry and verifies a fresh install, then pushes the v<version> git tag, publishes to the primary registry, verifies the install again, and finally creates a GitHub Release with auto-generated notes.

For doing testing of the GBG Remote interface:

Open a connection to the EC2 instance hosting GBG in AWS:

aws ssm start-session --target i-033eef3ccfbe82829 --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8080"],"localPortNumber":["8080"]}'

Snapshots during testing

When running the unit test suite, pytest-recording library is used. If it gives you errors about a cassette missing, the parameter to invoke a live HTTP request is --record-mode=once (add on to the end of the pytest command)

Updating from the template

This repository uses a copier template. To pull in the latest updates from the template, use the command: copier update --answers-file .config/.copier-answers.yml --trust --conflict rej --defaults