biosero-data-services-sdk 0.8.0

SDK for interacting with the Biosero Data Services API

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.

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

aws ssm start-session --target i-0e5fd6d0bcdfd3c03 --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8105"],"localPortNumber":["8105"]}'

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)

To run e2e tests locally against a specific data services version:

DATA_SERVICES_VERSION=1.6.2 uv run pytest tests/e2e
DATA_SERVICES_VERSION=2.0.0 uv run pytest tests/e2e

DATA_SERVICES_VERSION controls which Docker image docker-compose pulls. It defaults to 1.6.2 if unset.

Updating from the template

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