gbg-remote-sdk 0.1.1

Software Development Kit for the SOAP-based API for Green Button Go Remote Control

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.

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 --trust --conflict rej --defaults