gbg-remote-sdk 0.1.0__tar.gz

gbg_remote_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: gbg-remote-sdk
+Version: 0.1.0
+Summary: Software Development Kit for the SOAP-based API for Green Button Go Remote Control
+Author: Eli Fine
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12.7
+Description-Content-Type: text/markdown
+Requires-Dist: zeep>=4.3.2
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: requests>=2.32.5
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Actions status](https://github.com/lab-sync/gbg-remote-sdk/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/lab-sync/gbg-remote-sdk/actions)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk)
+[![PyPI Version](https://img.shields.io/pypi/v/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Downloads](https://pepy.tech/badge/gbg-remote-sdk)](https://pepy.tech/project/gbg-remote-sdk)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Codecov](https://codecov.io/gh/lab-sync/gbg-remote-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/lab-sync/gbg-remote-sdk)
+
+# Usage
+Documentation is hosted on [ReadTheDocs](https://gbg-remote-sdk.readthedocs.io/en/latest/?badge=latest).
+
+# Development
+This project has a dev container. If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk) 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:
+```bash
+aws ssm start-session --target i-033eef3ccfbe82829 --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8080"],"localPortNumber":["8080"]}'
+```
+
+### 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`

gbg_remote_sdk-0.1.0/README.md

@@ -0,0 +1,32 @@
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Actions status](https://github.com/lab-sync/gbg-remote-sdk/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/lab-sync/gbg-remote-sdk/actions)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk)
+[![PyPI Version](https://img.shields.io/pypi/v/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Downloads](https://pepy.tech/badge/gbg-remote-sdk)](https://pepy.tech/project/gbg-remote-sdk)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Codecov](https://codecov.io/gh/lab-sync/gbg-remote-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/lab-sync/gbg-remote-sdk)
+
+# Usage
+Documentation is hosted on [ReadTheDocs](https://gbg-remote-sdk.readthedocs.io/en/latest/?badge=latest).
+
+# Development
+This project has a dev container. If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk) 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:
+```bash
+aws ssm start-session --target i-033eef3ccfbe82829 --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8080"],"localPortNumber":["8080"]}'
+```
+
+### 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`

gbg_remote_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "gbg-remote-sdk"
+version = "0.1.0"
+description = "Software Development Kit for the SOAP-based API for Green Button Go Remote Control"
+authors = [
+    {name = "Eli Fine"},
+
+]
+readme = "README.md"
+requires-python = ">=3.12.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+
+    "Programming Language :: Python :: 3.12",
+
+    "Programming Language :: Python :: 3.13",
+
+]
+dependencies = [
+    "zeep>=4.3.2",
+    "pydantic>=2.11.7",
+    "requests>=2.32.5",
+]
+
+
+[dependency-groups]
+dev = [
+    # Specific to this repository
+    "vcrpy>=7.0.0",
+    "pytest-recording>=0.13.4",
+
+    # Managed by upstream template
+    "pyright>=1.1.405",
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+    "pytest-randomly>=4.0.1",
+
+
+]
+
+[tool.setuptools]
+license-files = [] # kludge until this bug is fixed https://github.com/pypa/setuptools/issues/4759
+
+[tool.uv]
+package = true
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple/"
+publish-url = "https://upload.pypi.org/legacy/"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"

gbg_remote_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk/__init__.py

@@ -0,0 +1,23 @@
+from .constants import INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX
+from .constants import InstrumentName
+from .constants import InstrumentStatus
+from .constants import OrderStatus
+from .constants import ProgramStatus
+from .exceptions import GbgVariableNotFoundError
+from .exceptions import NoGbgProgramLoadedError
+from .exceptions import WorkcellProcessNotAvailableError
+from .models import WorkcellProcessParameter
+from .sdk import GbgRemoteSdk
+
+__all__ = [
+    "INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX",
+    "GbgRemoteSdk",
+    "GbgVariableNotFoundError",
+    "InstrumentName",
+    "InstrumentStatus",
+    "NoGbgProgramLoadedError",
+    "OrderStatus",
+    "ProgramStatus",
+    "WorkcellProcessNotAvailableError",
+    "WorkcellProcessParameter",
+]

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk/constants.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX = ".Status"
+type InstrumentName = str
+
+
+class ProgramStatus(str, Enum):
+    IDLE = "Idle"
+    RUNNING = "Running"
+    PAUSED = "Paused"
+    ERROR = "Error"
+
+
+class InstrumentStatus(str, Enum):
+    READY = "Ready"
+    BUSY = "Busy"
+    ERROR = "Error"
+    LOCKED = "Locked"
+    UNKNOWN = "Unknown"
+
+
+class OrderStatus(str, Enum):
+    UNKNOWN = "Unkown"  # yes, this is really misspelled in the API response # spellchecker:disable-line
+    CANCELED = "Canceled"
+    COMPLETE = "Complete"
+    RUNNING = "Running"
+    SCHEDULED = "Scheduled"  # TODO: explicitly test this---but it was observed in the wild
+    ERROR = "Error"  # guessing that this is possible in a fixed version of GBG, but not tested yet

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk/exceptions.py

@@ -0,0 +1,19 @@
+class GbgRemoteApiError(Exception):
+    pass
+
+
+class NoGbgProgramLoadedError(GbgRemoteApiError):
+    def __init__(self, *, attempted_action: str):
+        super().__init__(f"No GBG program is loaded. Attempted action cannot be completed: {attempted_action}")
+
+
+class WorkcellProcessNotAvailableError(GbgRemoteApiError):
+    def __init__(self, *, process_name: str, available_process_names: list[str]):
+        super().__init__(
+            f"Workcell process not available: {process_name}\nAvailable processes: {', '.join(available_process_names)}"
+        )
+
+
+class GbgVariableNotFoundError(GbgRemoteApiError):
+    def __init__(self, variable_name: str):
+        super().__init__(f"Variable not found: {variable_name}")

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk/models.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel
+
+
+class WorkcellProcessParameter(BaseModel):
+    variable_name: str
+    variable_value: bool | int | float | str | None
+
+    @property
+    def variable_value_in_gbg_format(self) -> str:
+        """Convert the variable value to a string that GBG can understand."""
+        if self.variable_value is None:
+            return ""
+        if isinstance(self.variable_value, bool):
+            return "True" if self.variable_value else "False"
+        if isinstance(self.variable_value, (float, int)):
+            if int(self.variable_value) == self.variable_value:
+                return str(int(self.variable_value))
+        return str(self.variable_value)

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk/sdk.py

@@ -0,0 +1,199 @@
+import io
+import logging
+from collections.abc import Callable
+from functools import partial
+from ipaddress import IPv4Address
+from pathlib import Path
+from time import perf_counter_ns
+from typing import Any
+from typing import cast
+
+import requests
+from zeep import Client
+from zeep.exceptions import Fault
+from zeep.transports import Transport
+
+from .constants import INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX
+from .constants import InstrumentName
+from .constants import InstrumentStatus
+from .constants import OrderStatus
+from .constants import ProgramStatus
+from .exceptions import GbgVariableNotFoundError
+from .exceptions import NoGbgProgramLoadedError
+from .exceptions import WorkcellProcessNotAvailableError
+from .models import WorkcellProcessParameter
+
+logger = logging.getLogger(__name__)
+
+
+class GbgRemoteSdk:
+    def __init__(self, *, hostname: str | IPv4Address = "localhost", port: int = 8080, route: str = "/GBGRemote"):
+        super().__init__()
+        path_to_wsdl = Path(__file__).parent / "vendor_files" / "wsdl.xml"
+        # TODO: obtain the WSDL from the API endpoint and compare it to the local copy to ensure it matches expectations
+        with path_to_wsdl.open("r", encoding="utf-8") as f:
+            original_wsdl = f.read()
+        endpoint = f"http://{hostname!s}:{port}{route}"
+        wsdl_with_desired_endpoint = original_wsdl.replace("http://localhost:8080/GBGRemote", endpoint)
+        self._client = Client(
+            io.StringIO(wsdl_with_desired_endpoint),
+            transport=Transport(
+                timeout=0.5,  # pyright: ignore[reportArgumentType] # zeep says it only wants ints, but it's just passing it to requests, which accepts floats
+                operation_timeout=3,
+            ),
+        )
+        self._short_timeout_client = Client(
+            self._client.wsdl,
+            transport=Transport(
+                timeout=0.5,  # pyright: ignore[reportArgumentType] # zeep says it only wants ints, but it's just passing it to requests, which accepts floats
+                operation_timeout=0.5,
+            ),
+        )
+        self.hostname = str(hostname)  # tried converting everything to Ipv4address, but it didn't work with localhost
+        self.port = port
+        self.route = route
+
+    # Known problems: GetStatus will return "Running" even when an error is thrown (later version of GBG fixes this)
+    # GetStatusDetails just appears to return an empty string (although maybe if there was an error, it would return something more meaningful)
+    # There's no way to specifically get a list of instruments in the workcell---the workaround is just check all variable names for things that end in `.status`
+    # There's no known way to tell if GBG is simulating an instrument within a workcell
+    def _invoke_request(self, request: Callable[[], Any]) -> Any:  # noqa: ANN401 # yes, Any is generally bad, but zeep WSDL is terribly typed
+        start_time = perf_counter_ns()
+        response = request()
+        end_time = perf_counter_ns()
+        logger.debug(  # TODO: figure out how to include the request name and parameters in the log
+            "Invoked GBG Remote API method ", extra={"gbg_remote_api_call_duration_ns": end_time - start_time}
+        )
+        return response
+
+    def is_simulated(self) -> bool:
+        try:
+            response = self._invoke_request(self._client.service.GetIsSimulated)
+        except Fault as e:
+            if "Object reference not set to an instance of an object" in str(e):
+                raise NoGbgProgramLoadedError(attempted_action="GetIsSimulated") from e
+            raise  # pragma: no cover # not worth triggering a different type of error just to hit this default re-raise
+        response = cast(bool, response)
+        assert isinstance(response, bool), (
+            f"Expected response to be of type bool, but got type {type(response)} for {response}"
+        )
+        return response
+
+    def get_loaded_program(self) -> str | None:
+        response = cast(str, self._invoke_request(self._client.service.GetLoadedProgram))
+        assert isinstance(response, str), (
+            f"Expected response to be of type str, but got type {type(response)} for {response}"
+        )
+        if response == "None":
+            return None
+        return response
+
+    def is_api_reachable(self) -> bool:
+        try:
+            self._invoke_request(
+                self._short_timeout_client.service.GetLoadedProgram
+            )  # arbitrary API call that should always succeed
+        except requests.exceptions.ConnectionError:
+            return False
+        return True
+
+    def get_status(self) -> ProgramStatus:
+        response = cast(str, self._invoke_request(self._client.service.GetStatus))
+        assert isinstance(response, str), (
+            f"Expected response to be of type str, but got type {type(response)} for {response}"
+        )
+        return ProgramStatus(response)
+
+    def get_variable_names(self) -> list[str]:
+        response = self._invoke_request(self._client.service.GetVariableNames)
+        if (
+            response is None
+        ):  # there should never actually be no variables...this is what happens when no program is loaded
+            raise NoGbgProgramLoadedError(attempted_action="GetVariableNames")
+        response = cast(list[str], response)
+        assert isinstance(response, list), (
+            f"Expected response to be of type list, but got type {type(response)} for {response}"
+        )
+        return response
+
+    def get_variable_value(self, variable_name: str) -> str | None:
+        try:
+            response = self._invoke_request(partial(self._client.service.GetVariableValue, variable_name))  # pyright: ignore[reportUnknownArgumentType] # the WSDL is not typed
+        except Fault as e:
+            if "Get Variable Value could not find a variable named" in str(e):
+                raise GbgVariableNotFoundError(variable_name) from e
+            raise  # pragma: no cover # not worth triggering a different type of error just to hit this default re-raise
+        if response is None:
+            return None
+        response = cast(str, response)
+        assert isinstance(response, str), (
+            f"Expected response to be of type str, but got type {type(response)} for {response}"
+        )
+
+        return response
+
+    def get_instrument_statuses(self) -> dict[InstrumentName, InstrumentStatus]:
+        statuses: dict[InstrumentName, InstrumentStatus] = {}
+        try:
+            variable_names = self.get_variable_names()
+        except NoGbgProgramLoadedError as e:
+            raise NoGbgProgramLoadedError(attempted_action="GetInstrumentStatuses") from e
+        for variable_name in variable_names:
+            if variable_name.endswith(INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX):
+                instrument_name = variable_name[: -len(INSTRUMENT_STATUS_VARIABLE_NAME_SUFFIX)]
+                status = self.get_variable_value(variable_name)
+                statuses[instrument_name] = InstrumentStatus.UNKNOWN if status is None else InstrumentStatus(status)
+        return statuses
+
+    def start_workcell_process(
+        self, *, process_name: str, order_id: str, parameters: list[WorkcellProcessParameter]
+    ) -> str:
+        """Start a workcell process and return the RunID that was started."""
+        available_processes = self.get_available_workcell_processes()
+        if process_name not in available_processes:
+            raise WorkcellProcessNotAvailableError(
+                process_name=process_name, available_process_names=available_processes
+            )
+
+        # many things were attempted to use native python data structures of list/dict, but nothing worked except this
+        array_type = self._client.get_type(  # pyright: ignore[reportUnknownMemberType] # zeep WSDL is not typed
+            "{http://schemas.microsoft.com/2003/10/Serialization/Arrays}ArrayOfKeyValueOfstringstring"
+        )
+        assert array_type is not None, "Failed to get the ArrayOfKeyValueOfstringstring type from the WSDL"
+
+        parsed_parameters = array_type(
+            KeyValueOfstringstring=[
+                {"Key": param.variable_name, "Value": param.variable_value_in_gbg_format} for param in parameters
+            ]
+        )
+
+        response = self._invoke_request(
+            partial(  # pyright: ignore[reportUnknownArgumentType] # the WSDL is not typed
+                self._client.service.Run,
+                workcellProcessName=process_name,
+                orderId=order_id,
+                parameters=parsed_parameters,
+            )
+        )
+        assert isinstance(response, str), (
+            f"Expected response to be of type str, but got type {type(response)} for {response}"
+        )
+        return response
+
+    def get_order_status(self, order_id: str) -> OrderStatus:
+        response = self._invoke_request(
+            partial(  # pyright: ignore[reportUnknownArgumentType] # the WSDL is not typed
+                self._client.service.GetOrderStatus, orderId=order_id
+            )
+        )
+        assert isinstance(response, str), (
+            f"Expected response to be of type str, but got type {type(response)} for {response}"
+        )
+        return OrderStatus(response)
+
+    def get_available_workcell_processes(self) -> list[str]:
+        response = self._invoke_request(self._client.service.GetAvailableWorkcellProcesses)
+        assert isinstance(response, list), (
+            f"Expected response to be of type list, but got type {type(response)} for {response}"
+        )
+        return cast(list[str], response)

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: gbg-remote-sdk
+Version: 0.1.0
+Summary: Software Development Kit for the SOAP-based API for Green Button Go Remote Control
+Author: Eli Fine
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12.7
+Description-Content-Type: text/markdown
+Requires-Dist: zeep>=4.3.2
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: requests>=2.32.5
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Actions status](https://github.com/lab-sync/gbg-remote-sdk/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/lab-sync/gbg-remote-sdk/actions)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk)
+[![PyPI Version](https://img.shields.io/pypi/v/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Downloads](https://pepy.tech/badge/gbg-remote-sdk)](https://pepy.tech/project/gbg-remote-sdk)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gbg-remote-sdk.svg)](https://pypi.org/project/gbg-remote-sdk/)
+[![Codecov](https://codecov.io/gh/lab-sync/gbg-remote-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/lab-sync/gbg-remote-sdk)
+
+# Usage
+Documentation is hosted on [ReadTheDocs](https://gbg-remote-sdk.readthedocs.io/en/latest/?badge=latest).
+
+# Development
+This project has a dev container. If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/lab-sync/gbg-remote-sdk) 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:
+```bash
+aws ssm start-session --target i-033eef3ccfbe82829 --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8080"],"localPortNumber":["8080"]}'
+```
+
+### 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`

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+src/gbg_remote_sdk/__init__.py
+src/gbg_remote_sdk/constants.py
+src/gbg_remote_sdk/exceptions.py
+src/gbg_remote_sdk/models.py
+src/gbg_remote_sdk/py.typed
+src/gbg_remote_sdk/sdk.py
+src/gbg_remote_sdk.egg-info/PKG-INFO
+src/gbg_remote_sdk.egg-info/SOURCES.txt
+src/gbg_remote_sdk.egg-info/dependency_links.txt
+src/gbg_remote_sdk.egg-info/requires.txt
+src/gbg_remote_sdk.egg-info/top_level.txt

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk.egg-info/requires.txt

@@ -0,0 +1,3 @@
+zeep>=4.3.2
+pydantic>=2.11.7
+requests>=2.32.5

gbg_remote_sdk-0.1.0/src/gbg_remote_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+gbg_remote_sdk