localstack-sdk-python 0.0.2__tar.gz → 0.0.4__tar.gz

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: localstack-sdk-python
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python SDK for LocalStack
 Author-email: LocalStack Team <info@localstack.cloud>
 Project-URL: Homepage, https://localstack.cloud
@@ -12,23 +12,25 @@ License-File: LICENSE.txt
 Requires-Dist: localstack-sdk-generated
 
 # LocalStack Python SDK
+[![PyPI version](https://img.shields.io/pypi/v/localstack-sdk-python)](https://pypi.org/project/localstack-sdk-python/)
 
 This is the Python SDK for LocalStack.
 LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
 This SDK provides a programmatic and easy way to interact with them.
 
 > [!WARNING]
-> This project is still in a preview phase, and will be subject to fast and breaking changes.
+> This project is still in a preview phase and will be subject to fast and breaking changes.
 
 ### Project Structure
 
 This project follows the following structure:
 
-- `packages/localstack-sdk-generated` is a python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
-- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` has the main dependency.
+- `packages/localstack-sdk-generated` is a Python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
+LocalStack's OpenAPI specs are available in the [openapi repository](https://github.com/localstack/openapi).
+- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` as the main dependency.
 
 Developers are not supposed to modify at all `localstack-sdk-generated`.
-The code needs to be every time re-generated from specs using the `generate.sh` script in the `bin` folder.
+The code needs to be re-generated from specs every time using the `generate.sh` script in the `bin` folder.
 
 This project uses [uv](https://github.com/astral-sh/uv) as package/project manager.
 

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/README.md

@@ -1,21 +1,23 @@
 # LocalStack Python SDK
+[![PyPI version](https://img.shields.io/pypi/v/localstack-sdk-python)](https://pypi.org/project/localstack-sdk-python/)
 
 This is the Python SDK for LocalStack.
 LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
 This SDK provides a programmatic and easy way to interact with them.
 
 > [!WARNING]
-> This project is still in a preview phase, and will be subject to fast and breaking changes.
+> This project is still in a preview phase and will be subject to fast and breaking changes.
 
 ### Project Structure
 
 This project follows the following structure:
 
-- `packages/localstack-sdk-generated` is a python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
-- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` has the main dependency.
+- `packages/localstack-sdk-generated` is a Python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
+LocalStack's OpenAPI specs are available in the [openapi repository](https://github.com/localstack/openapi).
+- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` as the main dependency.
 
 Developers are not supposed to modify at all `localstack-sdk-generated`.
-The code needs to be every time re-generated from specs using the `generate.sh` script in the `bin` folder.
+The code needs to be re-generated from specs every time using the `generate.sh` script in the `bin` folder.
 
 This project uses [uv](https://github.com/astral-sh/uv) as package/project manager.
 

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/aws/__init__.py

@@ -0,0 +1,3 @@
+from localstack.sdk.aws.client import AWSClient
+
+__all__ = ["AWSClient"]

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/aws/client.py

@@ -0,0 +1,186 @@
+import json
+
+from localstack.sdk.api.aws_api import AwsApi
+from localstack.sdk.clients import BaseClient
+from localstack.sdk.models import (
+    Message,
+    SesSentEmail,
+    SNSPlatformEndpointResponse,
+    SNSSMSMessagesResponse,
+)
+
+
+def _from_sqs_query_to_json(xml_dict: dict) -> list[Message]:
+    """
+    todo: developer endpoint implements sqs-query protocol. Remove this workaround one we move them to json.
+    """
+    raw_messages = (
+        xml_dict.get("ReceiveMessageResponse", {}).get("ReceiveMessageResult", {}) or {}
+    ).get("Message", [])
+    if isinstance(raw_messages, dict):
+        raw_messages = [raw_messages]
+    messages = []
+    for msg in raw_messages:
+        _attributes = msg.get("Attribute", [])
+        attributes = {i["Name"]: i["Value"] for i in _attributes}
+        _m = {
+            "MessageId": msg.get("MessageId"),
+            "ReceiptHandle": msg.get("ReceiptHandle"),
+            "MD5OfBody": msg.get("MD5OfBody"),
+            "Body": msg.get("Body"),
+            "Attributes": attributes,
+        }
+        m = Message.from_dict(_m)
+        messages.append(m)
+    return messages
+
+
+class AWSClient(BaseClient):
+    """
+    The client to interact with all the LocalStack's AWS endpoints.
+    These endpoints offer specific features in addition to the ones offered by the AWS services. For instance,
+    access all the messages withing a SQS without the side effect of deleting them.
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._client = AwsApi(self._api_client)
+
+    ########
+    # SQS
+    ########
+
+    def list_sqs_messages(self, account_id: str, region: str, queue_name: str) -> list[Message]:
+        """
+        Lists all the SQS messages in a given queue in a specific account id and region, without any side effect.
+
+        :param account_id: the account id of the queue
+        :param region: the region of the queue
+        :param queue_name: the name of the queue
+        :return: the list of messages in the queue
+        """
+        response = self._client.list_sqs_messages_with_http_info(
+            account_id=account_id, region=region, queue_name=queue_name
+        )
+        return _from_sqs_query_to_json(json.loads(response.raw_data))
+
+    def list_sqs_messages_from_queue_url(self, queue_url: str) -> list[Message]:
+        """
+        Lists all the SQS messages in a given queue, without any side effect.
+
+        :param queue_url: the URL of the queue
+        :return: the list of messages in the queue
+        """
+        response = self._client.list_all_sqs_messages_with_http_info(queue_url=queue_url)
+        return _from_sqs_query_to_json(json.loads(response.raw_data))
+
+    ########
+    # SES
+    ########
+
+    def get_ses_messages(
+        self, id_filter: str | None = None, email_filter: str | None = None
+    ) -> list[SesSentEmail]:
+        """
+        Returns all the in-memory saved SES messages. They can be filtered by message ID and/or message source.
+
+        :param id_filter: the message id used as filter for the SES messages
+        :param email_filter: the message source filter
+        :return: a list of email sent with SES
+        """
+        response = self._client.get_ses_messages(id=id_filter, email=email_filter)
+        return response.messages
+
+    def discard_ses_messages(self, id_filter: str | None = None) -> None:
+        """
+        Clears all SES messages. An ID filter can be provided to delete only a specific message.
+
+        :param id_filter: the id filter
+        :return: None
+        """
+        return self._client.discard_ses_messages(id=id_filter)
+
+    ########
+    # SNS
+    ########
+
+    def get_sns_sms_messages(
+        self,
+        phone_number: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> SNSSMSMessagesResponse:
+        """
+        Returns all SMS messages published to a phone number.
+
+        :param phone_number: the phone number to which the messages have been published. If not specified, all messages
+            are returned.
+        :param account_id: the AWS Account ID from which the messages have been published. '000000000000' by default
+        :param region:  the AWS region from which the messages have been published. us-east-1 by default
+        :return:
+        """
+        return self._client.get_sns_sms_messages(
+            phone_number=phone_number, account_id=account_id, region=region
+        )
+
+    def discard_sns_sms_messages(
+        self,
+        phone_number: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> None:
+        """
+        Discards all SMS messages published to a phone number.
+
+        :param phone_number: the phone number to which the messages have been published. If not specified, all messages
+            are deleted.
+        :param account_id: the AWS Account ID from which the messages have been published. '000000000000' by default
+        :param region:  the AWS region from which the messages have been published. us-east-1 by default
+        :return: None
+        """
+        return self._client.discard_sns_sms_messages(
+            phone_number=phone_number, account_id=account_id, region=region
+        )
+
+    def get_sns_endpoint_messages(
+        self,
+        endpoint_arn: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> SNSPlatformEndpointResponse:
+        """
+        Returns all the messages published to a platform endpoint.
+
+        :param endpoint_arn: the ARN to which the messages have been published. If not specified, will return all the
+            messages.
+        :param account_id: the AWS Account ID from which the messages have been published. 000000000000 if not specified
+        :param region: the AWS region from which the messages have been published. us-east-1 by default
+        :return: a response with the list of messages and the queried region
+        """
+        return self._client.get_sns_endpoint_messages(
+            endpoint_arn=endpoint_arn, account_id=account_id, region=region
+        )
+
+    def discard_sns_endpoint_messages(
+        self,
+        endpoint_arn: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> None:
+        """
+        Discards all the messaged published to a platform endpoint.
+
+        :param endpoint_arn: the ARN to which the messages have been published. If not specified, will discard all the
+            messages.
+        :param account_id: the AWS Account ID from which the messages have been published. 000000000000 if not specified
+        :param region: the AWS region from which the messages have been published. us-east-1 by default
+        :return: None
+        """
+        return self._client.discard_sns_endpoint_messages(
+            endpoint_arn=endpoint_arn, account_id=account_id, region=region
+        )
+
+
+def get_default(**args) -> AwsApi:
+    """Return a client with a default configuration"""
+    return AwsApi(args)

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/chaos/client.py

@@ -0,0 +1,69 @@
+from localstack.sdk.api.chaos_api import ChaosApi
+from localstack.sdk.clients import BaseClient
+from localstack.sdk.models import FaultRule, NetworkEffectsConfig
+
+
+class ChaosClient(BaseClient):
+    """
+    The client to interact with the LocalStack's Chaos API.
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._client = ChaosApi(self._api_client)
+
+    def set_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Creates a new sets of fault rules. It overwrites the previous ones.
+        :param fault_rules: the list of FaultRule we want to set
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.set_fault_rules(fault_rule=fault_rules)
+
+    def add_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Adds a new set of rules to the current fault configuration.
+        :param fault_rules: the FaultRule rules to add
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.add_fault_rules(fault_rule=fault_rules)
+
+    def delete_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Deletes a set of rules from the fault configuration.
+        :param fault_rules: the FaultRule to delete
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.delete_fault_rules(fault_rule=fault_rules)
+
+    def get_fault_rules(self) -> list[FaultRule]:
+        """
+        Gets the current fault configuration.
+        :return: the list of FaultRule of the current configuration
+        """
+        return self._client.get_fault_rules()
+
+    def get_network_effects(self) -> NetworkEffectsConfig:
+        """
+        Gets the current network effect configuration.
+        :return: the current NetworkEffectsConfig
+        """
+        return self._client.get_network_effects()
+
+    def set_network_effects(
+        self, network_effects_config: NetworkEffectsConfig
+    ) -> NetworkEffectsConfig:
+        """
+        Configure a new network effect, e.g, latency.
+        :param network_effects_config: the network config to be set
+        :return: the current configuration of network effects
+        """
+        return self._client.set_network_effects(network_effects_config=network_effects_config)
+
+
+def get_default(**args) -> ChaosClient:
+    """
+    Return a chaos client with a default configuration. You can pass a host argument to overwrite the fault one
+    (http://localhost.localstack.cloud:4566).
+    """
+    return ChaosClient(**args)

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/localstack-sdk-python/localstack/sdk/chaos/managers.py

@@ -6,6 +6,11 @@ from localstack.sdk.models import FaultRule
 
 @contextmanager
 def fault_configuration(fault_rules: list[FaultRule]):
+    """
+    This is a context manager that temporarily applies a given set of fault rules.
+    :param fault_rules: a list of FaultRule to be applied.
+    :return: None
+    """
     client = get_default()
     try:
         client.set_fault_rules(fault_rules=fault_rules)

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/clients.py

@@ -0,0 +1,32 @@
+from localstack.sdk.api_client import ApiClient
+from localstack.sdk.configuration import Configuration
+
+
+class BaseClient:
+    """
+    A BaseClient creates a configuration and instantiate a ApiClient, which is a generic OpenAPI client automatically
+    generated by the openapitools/openapi-generator tool.
+    """
+
+    configuration: Configuration
+    """The configuration for the base client"""
+    _api_client: ApiClient
+    """The OpenAPI client"""
+    host: str
+    """The LocalStack host (http://localhost.localstack.cloud:4566 by default)"""
+    auth_token: str | None
+    """A client can be injected with a LocalStack auth token. If not provided, the one used to start up the
+    LocalStack instance will be used (for the features needing it, e.g., Cloud Pods)."""
+
+    def __init__(self, host: str | None = None, auth_token: str | None = None, **kwargs) -> None:
+        """
+        Initializes a base client to interact with LocalStack developer endpoint.
+        :param host: the host, http://localhost.localstack.cloud:4566 by default.
+        :param auth_token: if provided, this token would be used for authentication against platform. It not, the
+            LocalStack runtime will use the one used to start the container. The token used determines the Cloud
+            Pods identity, i.e., which pods are available.
+        """
+        self.host = host or "http://localhost.localstack.cloud:4566"
+        self.auth_token = auth_token
+        self.configuration = Configuration(host=self.host)
+        self._api_client = ApiClient(configuration=self.configuration)

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/pods/client.py

@@ -0,0 +1,115 @@
+import base64
+import json
+
+from localstack.sdk.api import PodsApi
+from localstack.sdk.clients import BaseClient
+from localstack.sdk.models import PodList, PodSaveRequest, RemoteConfig
+from localstack.sdk.pods.exceptions import PodLoadException, PodSaveException
+
+
+def _empty_remote_config() -> RemoteConfig:
+    return RemoteConfig(oneof_schema_1_validator={}, actual_instance={})
+
+
+def _read_ndjson(raw_content: bytes) -> list[dict]:
+    """
+    Reads the byte content of a ndjson response into a list of dictionaries.
+    :param raw_content: the byte content of a ndjson response.
+    :return: a list of dicts.
+    """
+    ndjson_str = raw_content.decode("utf-8")
+    return [json.loads(line) for line in ndjson_str.splitlines()]
+
+
+def _get_completion_event(streamed_response: list[dict]) -> dict | None:
+    """
+    Parses the chucked response returned form the Cloud Pod save and load endpoints and return the completion event,
+    i.e., the one summarizing the output (success or error) of the operation.
+    :param streamed_response: a list of dictionaries for the chunked response.
+    :return: the dictionary of the completion event, if found. None otherwise.
+    """
+    completion_events = [line for line in streamed_response if line.get("event") == "completion"]
+    return completion_events[0] if completion_events else None
+
+
+class PodsClient(BaseClient):
+    """
+    The client to interact with the Cloud Pod feature.
+    """
+
+    def __init__(self, **args) -> None:
+        """
+        Initializes a Cloud Pods client.
+        :param auth_token: if provided, this token will be used for platform authentication. If not, it will be
+            fetched from within the container itself.
+        """
+        super().__init__(**args)
+        self._client = PodsApi(self._api_client)
+        if self.auth_token:
+            # If an auth token is provided, it will be used to authenticate platform calls for Cloud Pods.
+            #   Only the pods tied to this token will be visible. If not provided, the token will be fetched from the
+            #   container. This allows to separate container identity for caller identity, if needed.
+            auth_header = get_platform_auth_header(self.auth_token)
+            self._api_client.set_default_header("Authorization", auth_header["Authorization"])
+
+    def save_pod(self, pod_name: str) -> None:
+        """
+        Saves the state in the LocalStack container into a Cloud Pod and uploads it to the LocalStack's platform.
+        If a Cloud Pod with the given name already exists, a new version is created.
+        :param pod_name: the name of the Cloud Pod to be saved.
+        :return: None
+        :raises PodSaveException: if the save operation returns an error
+        """
+        response = self._client.save_pod_with_http_info(
+            name=pod_name, pod_save_request=PodSaveRequest()
+        )
+        if response.status_code != 200:
+            raise PodSaveException(pod_name=pod_name)
+        streamed_response = _read_ndjson(response.raw_data)
+        completion_event = _get_completion_event(streamed_response)
+        if completion_event["status"] == "error":
+            raise PodSaveException(pod_name=pod_name, error=completion_event.get("message"))
+
+    def load_pod(self, pod_name: str) -> None:
+        """
+        Loads a Cloud Pod into the LocalStack container.
+        :param pod_name: the name of the Cloud Pod to load
+        :return: None
+        :raises PodLoadException: if the load operation returns an error
+        """
+        response = self._client.load_pod_with_http_info(
+            name=pod_name, remote_config=_empty_remote_config()
+        )
+        if response.status_code != 200:
+            raise PodLoadException(pod_name=pod_name)
+        streamed_response = _read_ndjson(response.raw_data)
+        completion_event = _get_completion_event(streamed_response)
+        if completion_event["status"] == "error":
+            raise PodLoadException(pod_name=pod_name, error=completion_event.get("message"))
+
+    def delete_pod(self, pod_name: str) -> None:
+        """
+        Deletes a Cloud Pod.
+        :param pod_name: the name of the Cloud Pod to be deleted.
+        :return: None
+        """
+        return self._client.delete_pod(name=pod_name, remote_config=_empty_remote_config())
+
+    def list_pods(self) -> PodList:
+        """
+        Returns the list of the Cloud Pods visible in the organization.
+        :return: a PodList object
+        """
+        pods = self._client.list_pods(remote_config=_empty_remote_config())
+        return pods
+
+
+def get_platform_auth_header(token: str) -> dict[str, str]:
+    """
+    Given the auth token, crafts the authorization header to authenticate platform calls.
+    :param token: the localstack auth token
+    :return: a dictionary for the authorization header
+    """
+    _token = f":{token}"
+    auth_encoded = base64.b64encode(_token.encode("utf-8")).decode("utf-8")
+    return {"Authorization": f"Basic {auth_encoded}"}

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/pods/exceptions.py

@@ -0,0 +1,18 @@
+class PodSaveException(Exception):
+    message = "An error occurred while saving the Cloud Pod"
+
+    def __init__(self, pod_name: str, error: str | None = None) -> None:
+        _message = f"{self.message} '{pod_name}'"
+        if error:
+            _message += f": {error}"
+        super().__init__(_message)
+
+
+class PodLoadException(Exception):
+    message = "An error occurred while loading the Cloud Pod"
+
+    def __init__(self, pod_name: str, error: str | None = None) -> None:
+        _message = f"{self.message} '{pod_name}'"
+        if error:
+            _message += f": {error}"
+        super().__init__(_message)

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/state/__init__.py

@@ -0,0 +1,3 @@
+from localstack.sdk.state.client import StateClient
+
+__all__ = ["StateClient"]

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/state/client.py

@@ -0,0 +1,19 @@
+from localstack.sdk.api import StateApi
+from localstack.sdk.clients import BaseClient
+
+
+class StateClient(BaseClient):
+    """
+    Initializes a client to handle LocalStack's state.
+    """
+
+    def __init__(self, **args) -> None:
+        super().__init__(**args)
+        self._client = StateApi(self._api_client)
+
+    def reset_state(self) -> None:
+        """
+        Resets the state of LocalStack for all running services.
+        :return: None
+        """
+        self._client.localstack_state_reset_post()

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/testing/__init__.py

@@ -0,0 +1,3 @@
+from localstack.sdk.testing.decorators import cloudpods
+
+__all__ = ["cloudpods"]

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/testing/decorators.py

@@ -0,0 +1,31 @@
+import logging
+from functools import wraps
+
+from localstack.sdk.pods import PodsClient
+from localstack.sdk.state import StateClient
+
+LOG = logging.getLogger(__name__)
+
+
+def cloudpods(*args, **kwargs):
+    """This is a decorator that loads a cloud pod before a test and resets the state afterward."""
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*test_args, **test_kwargs):
+            if not (pod_name := kwargs.get("name")):
+                raise Exception("Specify a Cloud Pod name in the `name` arg")
+            pods_client = PodsClient()
+            LOG.debug("Loading %s", pod_name)
+            pods_client.load_pod(pod_name=pod_name)
+            try:
+                result = func(*test_args, **test_kwargs)
+            finally:
+                LOG.debug("Reset state of the container")
+                state_client = StateClient()
+                state_client.reset_state()
+            return result
+
+        return wrapper
+
+    return decorator

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack/sdk/testing/pytest/plugins.py

@@ -0,0 +1,11 @@
+import pytest
+
+from localstack.sdk.state import StateClient
+
+
+@pytest.fixture
+def reset_state():
+    """This fixture is used to completely reset the state of LocalStack after a test runs."""
+    yield
+    state_client = StateClient()
+    state_client.reset_state()

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/localstack-sdk-python/localstack_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: localstack-sdk-python
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python SDK for LocalStack
 Author-email: LocalStack Team <info@localstack.cloud>
 Project-URL: Homepage, https://localstack.cloud
@@ -12,23 +12,25 @@ License-File: LICENSE.txt
 Requires-Dist: localstack-sdk-generated
 
 # LocalStack Python SDK
+[![PyPI version](https://img.shields.io/pypi/v/localstack-sdk-python)](https://pypi.org/project/localstack-sdk-python/)
 
 This is the Python SDK for LocalStack.
 LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
 This SDK provides a programmatic and easy way to interact with them.
 
 > [!WARNING]
-> This project is still in a preview phase, and will be subject to fast and breaking changes.
+> This project is still in a preview phase and will be subject to fast and breaking changes.
 
 ### Project Structure
 
 This project follows the following structure:
 
-- `packages/localstack-sdk-generated` is a python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
-- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` has the main dependency.
+- `packages/localstack-sdk-generated` is a Python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
+LocalStack's OpenAPI specs are available in the [openapi repository](https://github.com/localstack/openapi).
+- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` as the main dependency.
 
 Developers are not supposed to modify at all `localstack-sdk-generated`.
-The code needs to be every time re-generated from specs using the `generate.sh` script in the `bin` folder.
+The code needs to be re-generated from specs every time using the `generate.sh` script in the `bin` folder.
 
 This project uses [uv](https://github.com/astral-sh/uv) as package/project manager.
 

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/localstack-sdk-python/localstack_sdk_python.egg-info/SOURCES.txt

@@ -1,14 +1,24 @@
 LICENSE.txt
 README.md
 pyproject.toml
-localstack-sdk-python/localstack/clients.py
+localstack-sdk-python/localstack/sdk/clients.py
+localstack-sdk-python/localstack/sdk/aws/__init__.py
+localstack-sdk-python/localstack/sdk/aws/client.py
 localstack-sdk-python/localstack/sdk/chaos/__init__.py
 localstack-sdk-python/localstack/sdk/chaos/client.py
 localstack-sdk-python/localstack/sdk/chaos/managers.py
 localstack-sdk-python/localstack/sdk/pods/__init__.py
 localstack-sdk-python/localstack/sdk/pods/client.py
+localstack-sdk-python/localstack/sdk/pods/exceptions.py
+localstack-sdk-python/localstack/sdk/state/__init__.py
+localstack-sdk-python/localstack/sdk/state/client.py
+localstack-sdk-python/localstack/sdk/testing/__init__.py
+localstack-sdk-python/localstack/sdk/testing/decorators.py
+localstack-sdk-python/localstack/sdk/testing/pytest/__init__.py
+localstack-sdk-python/localstack/sdk/testing/pytest/plugins.py
 localstack-sdk-python/localstack_sdk_python.egg-info/PKG-INFO
 localstack-sdk-python/localstack_sdk_python.egg-info/SOURCES.txt
 localstack-sdk-python/localstack_sdk_python.egg-info/dependency_links.txt
+localstack-sdk-python/localstack_sdk_python.egg-info/entry_points.txt
 localstack-sdk-python/localstack_sdk_python.egg-info/requires.txt
 localstack-sdk-python/localstack_sdk_python.egg-info/top_level.txt

localstack_sdk_python-0.0.4/localstack-sdk-python/localstack_sdk_python.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+localstack = localstack.sdk.testing.pytest.plugins

{localstack_sdk_python-0.0.2 → localstack_sdk_python-0.0.4}/pyproject.toml

@@ -5,7 +5,7 @@ description = "Python SDK for LocalStack"
 authors = [
         { name = "LocalStack Team", email = "info@localstack.cloud"}
 ]
-version = "0.0.2"
+version = "0.0.4"
 dependencies = [
     "localstack-sdk-generated"
 ]
@@ -25,8 +25,10 @@ readme = { file = ["README.md"], content-type = "text/markdown"}
 
 [tool.uv]
 dev-dependencies=[
-    "pytest",
-    "ruff"
+    "pytest>=8.3.3",
+    "ruff>=0.6.9",
+    "boto3>=1.35.40",
+    "sphinx>=8.1.3"
 ]
 
 [tool.uv.sources]
@@ -45,6 +47,9 @@ where = ["localstack-sdk-python/"]
 include = ["localstack*"]
 exclude = ["tests*"]
 
+[project.entry-points.pytest11]
+localstack = "localstack.sdk.testing.pytest.plugins"
+
 [tool.ruff]
 # Always generate Python 3.8-compatible code.
 target-version = "py38"

localstack_sdk_python-0.0.2/localstack-sdk-python/localstack/clients.py

@@ -1,18 +0,0 @@
-import os
-
-from localstack.sdk.api_client import ApiClient
-from localstack.sdk.configuration import Configuration
-
-
-class BaseClient:
-    """A BaseClient creates a configuration and instantiate a ApiClient"""
-
-    configuration: Configuration
-    _api_client: ApiClient
-    auth_token: str | None
-
-    def __init__(self, host: str | None = None, auth_token: str | None = None, **kwargs) -> None:
-        _host = host or "http://localhost.localstack.cloud:4566"
-        self.auth_token = auth_token or os.getenv("LOCALSTACK_AUTH_TOKEN", "").strip("'\" ")
-        self.configuration = Configuration(host=_host)
-        self._api_client = ApiClient(configuration=self.configuration)

localstack_sdk_python-0.0.2/localstack-sdk-python/localstack/sdk/chaos/client.py

@@ -1,39 +0,0 @@
-from localstack.clients import BaseClient
-from localstack.sdk.api.chaos_api import ChaosApi
-from localstack.sdk.models import FaultRule, NetworkEffectsConfig
-
-
-class ChaosClient(BaseClient):
-    """
-    The client for the ChaosAPI.
-    This is mostly a wrapper of the ChaosApi class, which is automatically generated from the OpenAPI specs.
-    """
-
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        self._client = ChaosApi(self._api_client)
-
-    def set_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
-        return self._client.set_fault_rules_0(fault_rule=fault_rules)
-
-    def add_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
-        return self._client.add_fault_rules_0(fault_rule=fault_rules)
-
-    def delete_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
-        return self._client.delete_fault_rules_0(fault_rule=fault_rules)
-
-    def get_fault_rules(self) -> list[FaultRule]:
-        return self._client.get_fault_rules_0()
-
-    def get_network_effects(self) -> NetworkEffectsConfig:
-        return self._client.get_network_effects_0()
-
-    def set_network_effects(
-        self, network_effects_config: NetworkEffectsConfig
-    ) -> NetworkEffectsConfig:
-        return self._client.set_network_effects_0(network_effects_config=network_effects_config)
-
-
-def get_default(**args) -> ChaosClient:
-    """Return a default chaos client with a default configuration"""
-    return ChaosClient(**args)

localstack_sdk_python-0.0.2/localstack-sdk-python/localstack/sdk/pods/client.py

@@ -1,77 +0,0 @@
-import base64
-import json
-
-from localstack.clients import BaseClient
-from localstack.sdk.api import PodsApi
-from localstack.sdk.models import PodSaveRequest, RemoteConfig
-
-
-def _empty_remote_config() -> RemoteConfig:
-    return RemoteConfig(oneof_schema_1_validator={}, actual_instance={})
-
-
-def _read_ndjson(raw_content: bytes) -> list[dict]:
-    ndjson_str = raw_content.decode("utf-8")
-    return [json.loads(line) for line in ndjson_str.splitlines()]
-
-
-def _get_completion_event(streamed_response: list[dict]) -> dict | None:
-    completion_events = [line for line in streamed_response if line.get("event") == "completion"]
-    return completion_events[0] if completion_events else None
-
-
-class PodsClient(BaseClient):
-    def __init__(self, **args) -> None:
-        super().__init__(**args)
-        self._client = PodsApi(self._api_client)
-        # https://github.com/localstack/localstack-ext/pull/3469 could be avoided after this
-        assert self.auth_token
-        auth_header = get_platform_auth_header(self.auth_token)
-        self._api_client.set_default_header("Authorization", auth_header["Authorization"])
-
-    def save_pod(self, pod_name: str) -> None:
-        """
-        :raise exception if the save does not succeed
-        """
-        try:
-            response = self._client.save_pod_0_with_http_info(
-                name=pod_name, pod_save_request=PodSaveRequest()
-            )
-        except Exception as e:
-            raise (e)
-        if response.status_code != 200:
-            pass
-        streamed_response = _read_ndjson(response.raw_data)
-        completion_event = _get_completion_event(streamed_response)
-        if completion_event["status"] == "error":
-            # todo: define exception
-            raise Exception(completion_event.get("message"))
-
-    def load_pod(self, pod_name: str) -> None:
-        """
-        :raise exception if the load does not succeed
-        """
-        response = self._client.load_pod_0_with_http_info(
-            name=pod_name, remote_config=_empty_remote_config()
-        )
-        if response.status_code != 200:
-            pass
-        streamed_response = _read_ndjson(response.raw_data)
-        completion_event = _get_completion_event(streamed_response)
-        if completion_event["status"] == "error":
-            # todo: define exception
-            raise Exception(completion_event.get("message"))
-
-    def delete_pod(self, pod_name: str) -> None:
-        return self._client.delete_pod_0(name=pod_name, remote_config=_empty_remote_config())
-
-    def list_pods(self):
-        # todo: fix CloudPodInner model;
-        pods = self._client.list_pods_0(remote_config=_empty_remote_config())
-        return pods
-
-
-def get_platform_auth_header(token: str) -> dict[str, str]:
-    _token = f":{token}"
-    auth_encoded = base64.b64encode(_token.encode("utf-8")).decode("utf-8")
-    return {"Authorization": f"Basic {auth_encoded}"}